|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.adt.topology.handler.ProviderInfo
public final class ProviderInfo
This class is output from ConfigurationHandler.parseLocation() invocations to specify the type of TopologyProvider that must be instantiatied in order to process the artifacts within a given location. The provider-specific ConfigurationHandler also sets all required initialization properties to be passed in to TopologyProvider.initialize(Properties) as dictated by the provider implementation. This class provides support for passing initialization parameters in the form name/value pairs as well as key/object pairs.
ConfigurationHandler.parseLocation(String)
,
TopologyProvider.initialize(ProviderInfo)
,
Serialized FormConstructor Summary | |
---|---|
ProviderInfo(java.lang.String providerId,
java.lang.String location)
Creates a new ProviderInfo instance using the specified providerId and location. |
Method Summary | |
---|---|
java.lang.String |
getHandlerId()
Returns the id of the ConfigurationHandler that created this instance. |
java.lang.String |
getHandlerLocation()
Returns the initial location that was specified to the ConfigurationHandler when a provider match was found. |
java.lang.String |
getInitialLocation()
Gets the initial location that was given to a ConfigurationHandler. |
java.lang.String |
getLocation()
Gets the location associated with this provider. |
java.lang.Object |
getObject(java.lang.String key)
Gets an object from the ProviderInfo Object store associated with the specifed key. |
java.util.Properties |
getProperties()
Gets the initialization properties to be used when calling TopologyProvider.initialize(Properties). |
java.lang.String |
getProperty(java.lang.String key)
Gets a property from the ProviderInfo Properties store. |
java.lang.String |
getProperty(java.lang.String key,
java.lang.String defaultValue)
Gets a property from the ProviderInfo Properties store. |
java.lang.String |
getProviderId()
Gets the TopologyProvider id. |
void |
relocate(java.lang.String src,
java.lang.String dst)
Relocates the artifacts associated with this provider to a different location. |
void |
serializeToFile(java.lang.String filename)
Serialize this ProviderInfo instance to the specified file. |
(package private) void |
setHandlerId(java.lang.String handlerId)
Saves the id of the ConfigurationHandler instance that created this instance. |
(package private) void |
setHandlerLocation(java.lang.String handlerLocation)
Saves the location that was given to the ConfigurationHandler instance that found the provider match. |
(package private) void |
setInitialLocation(java.lang.String initialLocation)
Saves the initial location that was given to a ConfigurationHandler. |
void |
setObject(java.lang.String key,
java.lang.Object object)
Sets an object in the ProviderInfo Object store using the specified key. |
void |
setProperties(java.util.Properties properties)
Copies all specified properties to the ProviderInfo property store. |
void |
setProperty(java.lang.String key,
java.lang.String value)
Sets a property in the ProviderInfo Properties store. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ProviderInfo(java.lang.String providerId, java.lang.String location)
providerId
- the provider typelocation
- the locationMethod Detail |
---|
void setHandlerLocation(java.lang.String handlerLocation)
handlerLocation
- the handlerLocation to setvoid setInitialLocation(java.lang.String initialLocation)
initialLocation
- the initialLocation to setvoid setHandlerId(java.lang.String handlerId)
handlerId
- the handlerId to setpublic java.util.Properties getProperties()
com.ibm.adt.topology.provider.TopologyProvider#initialize(Properties)
public void setProperties(java.util.Properties properties)
properties
- public java.lang.String getLocation()
public java.lang.String getProviderId()
public void setProperty(java.lang.String key, java.lang.String value)
key
- the property keyvalue
- the property valuepublic java.lang.String getProperty(java.lang.String key)
key
- the property key
public java.lang.String getProperty(java.lang.String key, java.lang.String defaultValue)
key
- the property keydefaultValue
- the property defaultValue
public void setObject(java.lang.String key, java.lang.Object object)
key
- the object keyobject
- the objectpublic java.lang.Object getObject(java.lang.String key)
key
- the object key
public void serializeToFile(java.lang.String filename) throws java.io.FileNotFoundException, java.io.IOException
filename
-
java.io.FileNotFoundException
java.io.IOException
public void relocate(java.lang.String src, java.lang.String dst)
src
- the source loactiondst
- the target locationpublic java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getHandlerId()
public java.lang.String getInitialLocation()
public java.lang.String getHandlerLocation()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |