com.raritantechnologies.genericInterface
Class SourceDescriptor

java.lang.Object
  com.raritantechnologies.genericInterface.SourceDescriptor

All Implemented Interfaces:

java.rmi.Remote, java.io.Serializable

public class SourceDescriptor

extends java.lang.Object

implements java.rmi.Remote, java.io.Serializable

Describes a SearchSource at a level sufficient to invoke a search via the Raritan Search API.

See Also:

Serialized Form

Method Summary

java.lang.String	getCategory() returns the source category.
FieldIterator	getFieldIterator() Returns an iterator on the metadata fields supported by the Search Source.
Searcher	getSearcher(java.lang.String userName, java.lang.String password, java.lang.String sessionID) returns an object that can execute searches against a source for a given user credentials.
Searcher	getSearcher(UserSession userSession) returns an object that can execute searches against a source for a given user credentials - contained within an active user session.
java.lang.String	getSourceName() Returns the name of the Search Source.
java.lang.String	getSourceType() returns the type of source (e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSourceName

public java.lang.String getSourceName()
                               throws java.rmi.RemoteException

Returns the name of the Search Source. Used as a key to acquire a specific SearchSource object from the Configuration Manager.

Throws:

java.rmi.RemoteException

getSourceType

public java.lang.String getSourceType()
                               throws java.rmi.RemoteException

returns the type of source (e.g. HTMLSearchSource, SOAPSearchSource, etc. )

Throws:

java.rmi.RemoteException

getCategory

public java.lang.String getCategory()
                             throws java.rmi.RemoteException

returns the source category. For simple source mapping configurations, the category is equivalent to the source name. For more advanced source mapping configuration, a source is retrieved using a combination of category and sourceType.

Throws:

java.rmi.RemoteException

getFieldIterator

public FieldIterator getFieldIterator()
                               throws java.rmi.RemoteException

Returns an iterator on the metadata fields supported by the Search Source.

Throws:

java.rmi.RemoteException

getSearcher

public Searcher getSearcher(java.lang.String userName,
                            java.lang.String password,
                            java.lang.String sessionID)
                     throws java.rmi.RemoteException

returns an object that can execute searches against a source for a given user credentials.

Throws:

java.rmi.RemoteException

getSearcher

public Searcher getSearcher(UserSession userSession)
                     throws java.rmi.RemoteException

returns an object that can execute searches against a source for a given user credentials - contained within an active user session.

Throws:

java.rmi.RemoteException