com.fatwire.agent
Class ProviderInfo

java.lang.Object
  extended by java.util.AbstractMap<K,V>
      extended by java.util.HashMap<java.lang.String,java.util.List<java.lang.String>>
          extended by com.fatwire.agent.Properties
              extended by com.fatwire.agent.ProviderInfo
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.util.List<java.lang.String>>

public class ProviderInfo
extends Properties

Content provider information block (or briefly provider). Provider could be considered as a certain external system in contrary to the connector IConnector which means the external system as a type. For example, Microsoft SharePoint connector can have several providers pointing to different sites with different user credentials IProviderSession and ProviderInfo have the relation 1-to-1. However when a new runtime runtime session is created a new IProviderSession is also created while ProvierInfo is reused. All providers are registered in 'catalog.xml' file as a provider element. Provider can have numerous use-defined properties placed into 'init-params' section.

See Also:
IProviderSession., IConnector., Serialized Form

Constructor Summary
ProviderInfo(java.lang.String connectorid, java.lang.String name)
          Constructor.
ProviderInfo(java.lang.String providerid, java.lang.String connectorid, java.lang.String name)
          Constructor.
 
Method Summary
 java.lang.String getConnectorID()
          Returns referenced connector identifier.
 java.lang.String getName()
          Gets provider descriptive name.
 java.lang.String getProviderID()
          Returns provider unique identifier.
 void setName(java.lang.String name)
          Changes provider descriptive name.
 
Methods inherited from class com.fatwire.agent.Properties
getPropertyValue, getPropertyValue, getPropertyValues, setPropertyValue, setPropertyValues
 
Methods inherited from class java.util.HashMap
clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values
 
Methods inherited from class java.util.AbstractMap
equals, hashCode, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Constructor Detail

ProviderInfo

public ProviderInfo(java.lang.String providerid,
                    java.lang.String connectorid,
                    java.lang.String name)
Constructor. Used to create information about an existent provider (provider id is known).

Parameters:
providerid - provider unique identifier.
connectorid - identifier of the referenced connector.
name - provider descriptive name.

ProviderInfo

public ProviderInfo(java.lang.String connectorid,
                    java.lang.String name)
Constructor. Used to create information about a new provider (provider id is unknown).

Parameters:
connectorid - identifier of the referenced connector.
name - provider descriptive name.
Method Detail

getName

public java.lang.String getName()
Gets provider descriptive name.

Returns:
provider name.

setName

public void setName(java.lang.String name)
Changes provider descriptive name.

Parameters:
name - new name to set.

getProviderID

public java.lang.String getProviderID()
Returns provider unique identifier.

Returns:
provider id.

getConnectorID

public java.lang.String getConnectorID()
Returns referenced connector identifier.

Returns:
connector id.