public abstract class LibraryProxy extends DeployedObjectGroupProxy implements DeployedObject
As of Integration Bus V10, libraries have been renamed to static libraries. See StaticLibraryProxy or SharedLibraryProxy instead.
Each static library deployed to an execution group or application, or shared library deployed to an execution group, can be represented by a LibraryProxy.
In order to use LibraryProxy objects, applications must first obtain handles to them, by asking an execution group or an application for one or more specified static or shared libraries. Here is an example of how to do this:
BrokerProxy b = BrokerProxy.getInstance( new IntegrationNodeConnectionParameters("localhost", 4414)); ExecutionGroupProxy e = b.getExecutionGroupByName("default"); LibraryProxy stlib = (LibraryProxy) e.getStaticLibraryByName("aStaticLibrary");
BrokerProxy b = BrokerProxy.getInstance( new IntegrationNodeConnectionParameters("localhost", 4414)); ExecutionGroupProxy e = b.getExecutionGroupByName("default"); LibraryProxy shlib = (LibraryProxy) e.getSharedLibraryByName("aSharedLibrary");
com.ibm.broker.config.proxy.LibraryProxy extends
com.ibm.broker.config.proxy.DeployedObjectGroupProxy implements
com.ibm.broker.config.proxy.DeployedObject
|
|
Responsibilities | Acts as a container of deployed message flows. Provides the ability to deploy information to the library represented by each instance. |
Internal Collaborators | com.ibm.broker.config.proxy.MessageFlowProxy |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ 80006.1 2011-04-10 HDCAB Initial creation
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
copyright
IBM Copyright
|
protected static java.lang.String |
sccsid
Version information
|
baseRetryWaitTime, LOCAL_ATTRIBUTE_IDENTIFIER, maxRetries, objectUnavailable, owningPool, potentialNewSubcomponents, propertyUpdateLock, retryWaitTimeIncrement, subcomponentsToBeSubmittedForCreationInCurrentBatch, UUID_DELIMITER
BARNAME_KEYWORD, USAGE_KEYWORD, VERSION_KEYWORD
Modifier | Constructor and Description |
---|---|
protected |
LibraryProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop)
DO NOT USE THIS CONSTRUCTOR - use
ExecutionGroupProxy.getApplicationByName(String) instead.
|
protected |
LibraryProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop,
ConfigurationObjectType inParentType) |
Modifier and Type | Method and Description |
---|---|
DeployResult |
deleteDeployedObjects(DeployedObject[] forDeletion,
long timeToWaitMs)
This method overrides the base class
implementation, so that an exception is thrown if this method
is invoked against this class.
|
DeployResult |
deleteDeployedObjectsByName(java.lang.String[] forDeletion,
long timeToWaitMs)
This method overrides the base class
implementation, so that an exception is thrown if this method
is invoked against this class.
|
void |
deploy(java.io.InputStream barStream)
This method overrides the base class
implementation, so that an exception is thrown if this method
is invoked against this class.
|
DeployResult |
deploy(java.io.InputStream barStream,
java.lang.String barFileLabel,
boolean isIncremental,
long timeToWaitMs)
This method overrides the base class
implementation, so that an exception is thrown if this method
is invoked against this class.
|
void |
deploy(java.lang.String barFileName)
This method overrides the base class
implementation, so that an exception is thrown if this method
is invoked against this class.
|
DeployResult |
deploy(java.lang.String barFileName,
boolean isIncremental,
long timeToWaitMs)
This method overrides the base class
implementation, so that an exception is thrown if this method
is invoked against this class.
|
boolean |
fullNameMatches(java.lang.String fileName)
Tests if the name of this deployed object matches the
fileName passed in.
|
protected java.util.Properties |
getAdvancedProperties(boolean waitIfNotUpdated)
Returns a filtered list of the properties table associated with the
current object, removing any basic properties.
|
java.lang.String |
getBARFileName()
Returns the name of the BAR file that was used to deploy
the application to the execution group.
|
abstract ConfigurationObjectType |
getConfigurationObjectType()
Returns the ConfigurationObjectType associated
with this AdministeredObject type.
|
ConfigurationObjectType |
getConfigurationObjectTypeOfParent()
Returns the ConfigurationObjectType associated
with the logical parent of this AdministeredObject type.
|
java.util.Properties |
getDeployProperties()
Returns a list of the properties associated with the
deployment of this library.
|
java.util.Date |
getDeployTime()
Returns the time that the current message flow was
last deployed to the execution group.
|
ExecutionGroupProxy |
getExecutionGroup()
Returns a reference to the execution group on
which this library was deployed.
|
abstract java.lang.String |
getFileExtension()
Returns the file extension relevant to libraries, not
preceded by a '.' character.
|
java.lang.String |
getFullName()
Returns the name of the current deployable as it
existed in the BAR file at deployment time, including
any file extension but excluding any path information.
|
java.lang.String[] |
getKeywords()
Returns the set of keywords for this deployed object
which were found embedded in the object at deploy time.
|
java.lang.String |
getKeywordValue(java.lang.String keyword)
Returns the value of the supplied keyword.
|
java.util.Date |
getModifyTime()
Returns the time that the current message flow was
last modified, according to the file modification
associated with the cmf file in the broker archive.
|
java.lang.String |
getRuntimeProperty(java.lang.String objectAndPropertyName)
Returns the value of the runtime property with the supplied name.
|
protected abstract java.lang.String |
getRuntimePropertyFolder()
Returns the runtime property folder for this library type.
|
java.lang.String[] |
getRuntimePropertyNames()
Returns a string array of all runtime configurable service properties
associated with this object.
|
java.lang.String |
getVersion()
Returns the version string associated with the current
message flow.
|
void |
setName(java.lang.String name)
This method overrides the base class
implementation, so that an exception is thrown if this method
is invoked against this class.
|
void |
setRuntimeProperty(java.lang.String objectAndPropertyName,
java.lang.String propertyValue)
Asks the broker to configure an arbitrary library
property.
|
static java.util.Properties |
withName(java.lang.String name)
Deprecated.
as of Integration Bus V10, libraries have been
renamed to static libraries. Use StaticLibraryProxy.withName instead.
|
static java.util.Properties |
withUUID(java.lang.String uuid)
Deprecated.
as of Integration Bus V10, libraries have been
renamed to static libraries. Use StaticLibraryProxy.withUUID instead.
|
deploy, getDeployedObjectByName, getDeployedObjectFromSubcomponentString, getDeployedObjects, getDeployedObjects, getDeployedObjectsCount, getDeployedPolicySetBindingsNames, getDeployedPolicySetNames, getMessageFlow, getMessageFlowByName, getMessageFlowDependencies, getMessageFlows, getMessageSets, getNodeTypes, getQueues, getSubFlow, getSubFlowByName, getSubFlows, setAllMessageFlowsRuntimeProperties, setAllMessageFlowsRuntimeProperty, setUserTrace, startMessageFlows, stopMessageFlows, stopMessageFlows, stopMessageFlows
checkTypeAndBase64DecodePropertyValue, checkTypeAndBase64EncodePropertyValue, clearPredictedNewSubcomponents, createManagedSubcomponent, createManagedSubcomponent, createManagedSubcomponent, createManagedSubcomponent, deleteManagedSubcomponents, deregisterListener, deregisterListener, elements, equals, execute, getAdvancedProperties, getBasicProperties, getBasicProperties, getGrandParentUUIDProperties, getLastBIPMessages, getLastCompletionCode, getLastUpdateUser, getLongDescription, getManagedSubcomponent, getManagedSubcomponentFromStringRepresentation, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponentsAsStrings, getManagedSubcomponentsAsStrings, getName, getNumberOfSubcomponents, getParent, getProperties, getProperties, getProperty, getProperty, getProperty, getProperty, getProperty, getPropertyBaseName, getPropertyInt, getPropertyInternal, getRefreshRequired, getRepositoryTimestamp, getShortDescription, getTimeOfLastCompletionCode, getTimeOfLastUpdate, getType, getUUID, getUUIDOfGrandParent, getUUIDOfParent, hasBeenPopulatedByBroker, hasBeenPopulatedByBroker, hasBeenPopulatedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByConfigManager, hasBeenRestrictedByConfigManager, hasBeenUpdatedByConfigManager, hasBeenUpdatedByConfigManager, isAUserDefinedObjectDestructor, isAwaitingSubmissionForCreation, isAwaitingSubmissionForDeletion, isDeployed, isLastPropertyIdentifier, isPartOfAPropertyGroup, isShared, predictPropertiesOfNewObject, refresh, refresh, registerListener, registerListener, registerListener, removeLocalProperty, setIsAwaitingSubmissionForCreation, setIsAwaitingSubmissionForDeletion, setLastBIPMessages, setLastCompletionCode, setLocalProperty, setLongDescription, setProperties, setProperties, setRefreshRequired, setShortDescription, setTimeOfLastUpdate, toString, toVerboseString, unsubscribeFromConfigurationManagerUpdates, validateObjectAndPropertyName, validateServiceObjectAndPropertyName
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getName
protected static final java.lang.String copyright
protected static final java.lang.String sccsid
protected LibraryProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop)
aop
- The pool that will own this object.protected LibraryProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop, ConfigurationObjectType inParentType)
@Deprecated public static java.util.Properties withUUID(java.lang.String uuid)
@Deprecated public static java.util.Properties withName(java.lang.String name)
public abstract ConfigurationObjectType getConfigurationObjectType()
getConfigurationObjectType
in class DeployedObjectGroupProxy
protected abstract java.lang.String getRuntimePropertyFolder()
public ConfigurationObjectType getConfigurationObjectTypeOfParent()
getConfigurationObjectTypeOfParent
in class DeployedObjectGroupProxy
public void setRuntimeProperty(java.lang.String objectAndPropertyName, java.lang.String propertyValue) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
Constants exist for many common objectAndPropertyName values in the AttributeConstants interface, and you should use these wherever possible.
The list of currently defined property names can be obtained using the method getRuntimePropertyNames(). However, not all runtime properties returned by this method can be set.
objectAndPropertyName
- The complete object and property name of the
property being manipulatedpropertyValue
- The new value to associate with the propertyConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.java.lang.IllegalArgumentException
- if objectAndPropertyName is not of a valid syntax.public java.lang.String[] getRuntimePropertyNames()
public java.lang.String getRuntimeProperty(java.lang.String objectAndPropertyName) throws ConfigManagerProxyPropertyNotInitializedException, java.lang.IllegalArgumentException
If you wish to directly look up a specific named property, use constants defined in the AttributeConstants interface wherever possible. If a constant does not exist, the objectAndpropertyName parameter can be made up of a String of the form "ObjectName/PropertyName", where ObjectName and PropertyName are the object and property names supplied on the -o and -n parameters respectively of mqsireportproperties. The '/' separator is defined as AttributeConstants.OBJECT_NAME_DELIMITER.
objectAndPropertyName
- The name of the property to be reportedConfigManagerProxyPropertyNotInitializedException
- if the value of the property could not be determined because
the information was not supplied from the broker before a
timeout occurred.java.lang.IllegalArgumentException
- if objectAndPropertyName is not a valid syntax.public java.util.Properties getDeployProperties() throws ConfigManagerProxyPropertyNotInitializedException
This method will pause until the object has received at least one update from the broker. If an update is not received before the timeout specified in BrokerProxy.setRetryCharacteristics() is reached, AdministeredObject.hasBeenPopulatedByBroker() will return false and the returned Properties object will be null.
getDeployProperties
in interface DeployedObject
ConfigManagerProxyPropertyNotInitializedException
public ExecutionGroupProxy getExecutionGroup() throws ConfigManagerProxyLoggedException
getExecutionGroup
in interface DeployedObject
ConfigManagerProxyLoggedException
- if the parent
object is not immediately available and has to be
requested from the broker, but the
request could not be sent to the broker.DeployedObject.getExecutionGroup()
public java.lang.String getBARFileName() throws ConfigManagerProxyPropertyNotInitializedException
getBARFileName
in interface DeployedObject
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.lang.String[] getKeywords() throws ConfigManagerProxyPropertyNotInitializedException
See the DeployedObject class for an overview of how to associate keywords with deployed objects.
getKeywords
in interface DeployableObject
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.DeployableObject.getKeywords()
public java.lang.String getKeywordValue(java.lang.String keyword) throws ConfigManagerProxyPropertyNotInitializedException
See the DeployedObject class for an overview of how to associate keywords with deployed objects.
getKeywordValue
in interface DeployableObject
keyword
- The keyword to look upConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.DeployableObject.getKeywordValue(java.lang.String)
public java.lang.String getVersion() throws ConfigManagerProxyPropertyNotInitializedException
getVersion
in interface DeployableObject
ConfigManagerProxyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.DeployableObject.getVersion()
public java.util.Date getDeployTime()
getDeployTime
in interface DeployedObject
DeployedObject.getDeployTime()
public java.util.Date getModifyTime()
getModifyTime
in interface DeployableObject
DeployableObject.getModifyTime()
public abstract java.lang.String getFileExtension()
getFileExtension
in interface DeployableObject
DeployableObject.getFileExtension()
public java.lang.String getFullName() throws ConfigManagerProxyPropertyNotInitializedException
getFullName
in interface DeployableObject
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public boolean fullNameMatches(java.lang.String fileName) throws ConfigManagerProxyPropertyNotInitializedException
fullNameMatches
in interface DeployedObject
ConfigManagerProxyLoggedException
- if the parent
object is not immediately available and has to be
requested from the broker, but the
request could not be sent to the broker.ConfigManagerProxyPropertyNotInitializedException
public void setName(java.lang.String name) throws ConfigManagerProxyLoggedException
setName
in class AdministeredObject
name
- (this is ignored)ConfigManagerProxyLoggedException
- to indicate this
method should not be called.public DeployResult deploy(java.lang.String barFileName, boolean isIncremental, long timeToWaitMs) throws ConfigManagerProxyLoggedException, java.io.IOException
deploy
in class DeployedObjectGroupProxy
barFileName
- Path and file name of the Bar file,
relative to the current directory.isIncremental
- If true, the contents of the Bar
file will add or modify what has already been
deployed on the execution group.
If false, the contents of the execution group will
be completely cleared before deployment (also known
as a "complete" deploy).timeToWaitMs
- A positive value describes the
maximum length of time to wait for broker responses
(in milliseconds) before returning the DeployResult.
Alternatively:
ConfigManagerProxyLoggedException
- to indicate this
method should not be called.java.io.FileNotFoundException
- if the Bar file could not be foundjava.io.IOException
- if the file could not be closed.
In this case the deployment might have succeeded.public DeployResult deploy(java.io.InputStream barStream, java.lang.String barFileLabel, boolean isIncremental, long timeToWaitMs) throws ConfigManagerProxyLoggedException
deploy
in class DeployedObjectGroupProxy
barStream
- InputStream containing the BAR file
contents. The first byte read by the stream must be the
first byte of the Bar file's contents.barFileLabel
- the name of the Bar file being
deployed. Every DeployedObject that results from
this deployment will return this value (which may be null)
from the getBARFileName() method.isIncremental
- If true, the contents of the Bar
file will add or modify what has already been
deployed on the execution group.
If false, the contents of the execution group will
be completely cleared before deployment (also known
as a "complete" deploy).timeToWaitMs
- A positive value describes the
maximum length of time to wait for broker responses
(in milliseconds) before returning the DeployResult.
Alternatively:
ConfigManagerProxyLoggedException
- to indicate this
method should not be called.public void deploy(java.lang.String barFileName) throws ConfigManagerProxyLoggedException, java.io.IOException
deploy
in class DeployedObjectGroupProxy
barFileName
- Path and file name of the Bar file,
relative to the current directory.ConfigManagerProxyLoggedException
- to indicate this
method should not be called.java.io.FileNotFoundException
- if the Bar file could not be foundjava.io.IOException
- if the file could not be closed.
In this case the deployment might have succeeded.public void deploy(java.io.InputStream barStream) throws ConfigManagerProxyLoggedException
deploy
in class DeployedObjectGroupProxy
barStream
- InputStream containing the Bar file contents.
The first byte read by the stream must be the
first byte of the Bar file's contents.ConfigManagerProxyLoggedException
- to indicate this
method should not be called.public DeployResult deleteDeployedObjects(DeployedObject[] forDeletion, long timeToWaitMs) throws ConfigManagerProxyLoggedException
deleteDeployedObjects
in class DeployedObjectGroupProxy
forDeletion
- representing the DeployedObject objects
that require deletion (e.g. message flows, message sets).
If the value is null or empty, this method does nothing.
If an element in the array is null, the element is ignored.timeToWaitMs
- A positive value describes the
maximum length of time to wait for broker responses
(in milliseconds) before returning the DeployResult.
Alternatively:
ConfigManagerProxyLoggedException
- to indicate this
method should not be called.public DeployResult deleteDeployedObjectsByName(java.lang.String[] forDeletion, long timeToWaitMs) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
deleteDeployedObjectsByName
in class DeployedObjectGroupProxy
forDeletion
- An array of Strings, with each element
being the name (e.g. "mf1") or fullname (e.g. "mf1.cmf")
of an object that is to be removed from the execution group.
If the array is null or empty, this method does nothing.
If an element in the array is null, the element is ignored.timeToWaitMs
- A positive value describes the
maximum length of time to wait for broker responses
(in milliseconds) before returning the DeployResult.
Alternatively:
ConfigManagerProxyLoggedException
- to indicate this
method should not be called.ConfigManagerProxyPropertyNotInitializedException
- if deployed object information could not be determined because
the information was not supplied from the broker before a
timeout occurred.protected java.util.Properties getAdvancedProperties(boolean waitIfNotUpdated) throws ConfigManagerProxyPropertyNotInitializedException
getAdvancedProperties
in class AdministeredObject
waitIfNotUpdated
- Only if this value is true, the method
will pause until the object has received at least one update from
the broker. If an update is not received before the timeout specified
in BrokerProxy.setRetryCharacteristics() is reached,
AdministeredObject.hasBeenPopulatedByBroker() will return false and the returned
Properties object will contain a much smaller set of properties,
that the IBM Integration API (CMP) has derived from other
sources.ConfigManagerProxyPropertyNotInitializedException