com.epnet.eit2.rest.client
Class UserEIT2Client

java.lang.Object
  extended bycom.epnet.eit2.rest.client.AbstractEIT2Client
      extended bycom.epnet.eit2.rest.client.EIT2Client
          extended bycom.epnet.eit2.rest.client.UserEIT2Client

public class UserEIT2Client
extends EIT2Client

Convenient client, alternative to EIT2Client with preset profile and password. All methods will internally use the prof and pwd passed through the contructor.

Author:
msanchez@ebscohost.com

Field Summary
 
Fields inherited from class com.epnet.eit2.rest.client.AbstractEIT2Client
baseURI, browseServicePath, infoServicePath, searchServicePath
 
Constructor Summary
UserEIT2Client(java.lang.String host, java.lang.String prof, java.lang.String pwd)
          Creates a UserEIT2Client
 
Method Summary
 java.io.InputStream browse(java.lang.String term, java.lang.String db, java.lang.String index)
          The Browse method is used to view indexes such as Authors or Subject Terms on an EBSCOhost database.
 java.io.InputStream browse(java.lang.String term, java.lang.String numrec_20, java.lang.String db, java.lang.String index)
          The Browse method is used to view indexes such as Authors or Subject Terms on an EBSCOhost database.
 java.io.InputStream info()
          The Info method allows the Data Partner to receive a list of databases available to the given profile as well as the attributes of those databases such as the sort fields and indexes allowed by each database.
 java.io.InputStream search(java.lang.String query, java.lang.String db)
          The Search method is used to perform basic searches on EBSCOhost reference system.
 java.io.InputStream search(java.lang.String query, java.lang.String startrec_1, java.lang.String numrec_10, java.lang.String sort_date, java.lang.String db, java.lang.String format_brief, java.lang.String subset_)
          The Search method is used to perform basic searches on EBSCOhost reference system.
 
Methods inherited from class com.epnet.eit2.rest.client.EIT2Client
browse, browse, info, search, search
 
Methods inherited from class com.epnet.eit2.rest.client.AbstractEIT2Client
browse, info, search, service
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserEIT2Client

public UserEIT2Client(java.lang.String host,
                      java.lang.String prof,
                      java.lang.String pwd)
               throws EITClientException
Creates a UserEIT2Client

Parameters:
host - The EIT2 REST host
prof - EIT2 profile
pwd - Profile password
Throws:
EITClientException - If the host generates an improper URI
Method Detail

info

public java.io.InputStream info()
                         throws EITClientException
The Info method allows the Data Partner to receive a list of databases available to the given profile as well as the attributes of those databases such as the sort fields and indexes allowed by each database.

Returns:
InputStream to read from
Throws:
EITClientException - If any network errors occur with the request

browse

public java.io.InputStream browse(java.lang.String term,
                                  java.lang.String numrec_20,
                                  java.lang.String db,
                                  java.lang.String index)
                           throws EITClientException
The Browse method is used to view indexes such as Authors or Subject Terms on an EBSCOhost database. Note that the index availability can be different per database. This method accepts both mandatory and non-mandatory parameteers. Non-mandatory parameters are marked by "_"; set to null to use default value.

Parameters:
term - Browse terms
numrec_20 - Number of records to retrieve. Use for pagination.
db - DB to browse
index - Index to browse
Returns:
InputStream to read from
Throws:
EITClientException - If any network errors occur with the request

browse

public java.io.InputStream browse(java.lang.String term,
                                  java.lang.String db,
                                  java.lang.String index)
                           throws EITClientException
The Browse method is used to view indexes such as Authors or Subject Terms on an EBSCOhost database. Note that the index availability can be different per database. This method accepts only mandatory parameters.

Parameters:
term - Browse terms
db - DB to browse
index - Index to browse
Returns:
InputStream to read from
Throws:
EITClientException - If any network errors occur with the request

search

public java.io.InputStream search(java.lang.String query,
                                  java.lang.String startrec_1,
                                  java.lang.String numrec_10,
                                  java.lang.String sort_date,
                                  java.lang.String db,
                                  java.lang.String format_brief,
                                  java.lang.String subset_)
                           throws EITClientException
The Search method is used to perform basic searches on EBSCOhost reference system. Abstracts as well as the full text for documents and articles can be retrieved using this method. When available, full text articles can also be downloaded in pdf format. This method accepts both mandatory and non-mandatory parameteers. Non-mandatory parameters are marked by "_"; set to null to use default value.

Parameters:
query - Search terms. Can be a bquery.
startrec_1 - Start record. Use for pagination.
numrec_10 - Number of records to return at a time. Use for pagination.
sort_date - Sort type. Varies per database. Use infor to introspect DB.
db - DB to search
format_brief - Format type: brief, detailed, full.
subset_ - Use info method for DB subsets
Returns:
InputStream to read from
Throws:
EITClientException - If any network errors occur with the request

search

public java.io.InputStream search(java.lang.String query,
                                  java.lang.String db)
                           throws EITClientException
The Search method is used to perform basic searches on EBSCOhost reference system. Abstracts as well as the full text for documents and articles can be retrieved using this method. When available, full text articles can also be downloaded in pdf format. This method accepts only mandatory parameters.

Parameters:
query - Search terms. Can be a bquery.
db - DB to search
Returns:
InputStream to read from
Throws:
EITClientException - If any network errors occur with the request