public class StaticLibraryProxy extends LibraryProxy
Each static library deployed to an execution group can be represented by a StaticLibraryProxy.
In order to use StaticLibraryProxy objects, applications must first obtain handles to them. Here is an example of how to do this:
BrokerProxy b = BrokerProxy.getInstance( new IntegrationNodeConnectionParameters("localhost", 4414)); ExecutionGroupProxy e = b.getExecutionGroupByName("default"); StaticLibraryProxy shlib = e.getStaticLibraryByName("aStaticLibrary");
com.ibm.broker.config.proxy.StaticLibraryProxy extends
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 static 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 |
StaticLibraryProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop)
DO NOT USE THIS CONSTRUCTOR - use
ExecutionGroupProxy.getStaticLibraryByName(String) instead.
|
protected |
StaticLibraryProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop,
ConfigurationObjectType inParentType) |
Modifier and Type | Method and Description |
---|---|
ConfigurationObjectType |
getConfigurationObjectType()
Returns the ConfigurationObjectType associated
with this AdministeredObject type.
|
java.lang.String |
getFileExtension()
Returns the file extension relevant to static libraries, not
preceded by a '.' character.
|
protected java.lang.String |
getRuntimePropertyFolder()
Returns the runtime property folder for this library type.
|
void |
setAllMessageFlowsRuntimeProperties(java.util.Properties props)
Asks the broker to configure an arbitrary
set of properties of all message flows owned by the static library.
|
void |
setAllMessageFlowsRuntimeProperty(java.lang.String objectAndPropertyName,
java.lang.String propertyValue)
Asks the broker to configure an arbitrary
property of all message flows owned by the static library.
|
static java.util.Properties |
withName(java.lang.String name)
Returns a new Properties object that has the name attribute set
to the supplied String, and the type attribute to be the name of
the subclass of AdministeredObject being used.
|
static java.util.Properties |
withUUID(java.lang.String uuid)
Returns a new Properties object that has the UUID attribute set
to the supplied String, and the type attribute to be the name of
the subclass of AdministeredObject being used.
|
deleteDeployedObjects, deleteDeployedObjectsByName, deploy, deploy, deploy, deploy, fullNameMatches, getAdvancedProperties, getBARFileName, getConfigurationObjectTypeOfParent, getDeployProperties, getDeployTime, getExecutionGroup, getFullName, getKeywords, getKeywordValue, getModifyTime, getRuntimeProperty, getRuntimePropertyNames, getVersion, setName, setRuntimeProperty
deploy, getDeployedObjectByName, getDeployedObjectFromSubcomponentString, getDeployedObjects, getDeployedObjects, getDeployedObjectsCount, getDeployedPolicySetBindingsNames, getDeployedPolicySetNames, getMessageFlow, getMessageFlowByName, getMessageFlowDependencies, getMessageFlows, getMessageSets, getNodeTypes, getQueues, getSubFlow, getSubFlowByName, getSubFlows, 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 StaticLibraryProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop)
aop
- The pool that will own this object.protected StaticLibraryProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop, ConfigurationObjectType inParentType)
public static java.util.Properties withUUID(java.lang.String uuid)
public static java.util.Properties withName(java.lang.String name)
public ConfigurationObjectType getConfigurationObjectType()
getConfigurationObjectType
in class LibraryProxy
protected java.lang.String getRuntimePropertyFolder()
LibraryProxy
getRuntimePropertyFolder
in class LibraryProxy
public java.lang.String getFileExtension()
getFileExtension
in interface DeployableObject
getFileExtension
in class LibraryProxy
DeployableObject.getFileExtension()
public void setAllMessageFlowsRuntimeProperty(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.
setAllMessageFlowsRuntimeProperty
in class DeployedObjectGroupProxy
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 a valid syntax.public void setAllMessageFlowsRuntimeProperties(java.util.Properties props) 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.
setAllMessageFlowsRuntimeProperties
in class DeployedObjectGroupProxy
props
- A set of properties to set on all message flows owned by the static library.
The key is the complete object and property name of the property being manipulated.
The value is 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 a valid syntax.