public class SharedLibraryProxy extends LibraryProxy
Each shared library deployed to an execution group can be represented by a SharedLibraryProxy.
In order to use SharedLibraryProxy 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"); SharedLibraryProxy shlib = e.getSharedLibraryByName("aSharedLibrary");
com.ibm.broker.config.proxy.SharedLibraryProxy 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 shared 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 |
SharedLibraryProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop)
DO NOT USE THIS CONSTRUCTOR - use
ExecutionGroupProxy.getSharedLibraryByName(String) instead.
|
protected |
SharedLibraryProxy(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 shared libraries, not
preceded by a '.' character.
|
MessageFlowProxy |
getMessageFlow(java.util.Properties props)
Deprecated.
Shared libraries do not support message flows - do not call this method.
|
MessageFlowProxy |
getMessageFlowByName(java.lang.String messageFlowName)
Deprecated.
Shared libraries do not support message flows - do not call this method.
|
java.util.Enumeration<MessageFlowProxy> |
getMessageFlows(java.util.Properties filter)
Deprecated.
Shared libraries do not support message flows - do not call this method.
|
protected java.lang.String |
getRuntimePropertyFolder()
Returns the runtime property folder for this library type.
|
java.util.Map<SharedLibraryReference,SharedLibraryProxy> |
getSharedLibraryDependencies()
This method returns the shared libraries that this object depends on.
|
java.util.Enumeration<DeployedObjectGroupProxy> |
getSharedLibraryDependents()
This method returns the list of applications, integration services, or other shared
library objects that depend on this shared library.
|
void |
setAllMessageFlowsRuntimeProperties(java.util.Properties props)
Deprecated.
Shared libraries do not support message flows - do not call this method.
|
void |
setAllMessageFlowsRuntimeProperty(java.lang.String objectAndPropertyName,
java.lang.String propertyValue)
Deprecated.
Shared libraries do not support message flows - do not call this method.
|
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, getMessageFlowDependencies, 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 SharedLibraryProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop)
aop
- The pool that will own this object.protected SharedLibraryProxy(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 java.util.Map<SharedLibraryReference,SharedLibraryProxy> getSharedLibraryDependencies() throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- to indicate a problem
with retrieving the information.public java.util.Enumeration<DeployedObjectGroupProxy> getSharedLibraryDependents() throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- to indicate a problem
with retrieving the information.@Deprecated public MessageFlowProxy getMessageFlow(java.util.Properties props) throws ConfigManagerProxyPropertyNotInitializedException
getMessageFlow
in class DeployedObjectGroupProxy
props
- Filter to select the MessageFlowProxy
Each key is an attribute name of the required object
and each value is the required value of the attribute. A null or
empty Properties object will match an arbitrary message flow
deployed to this deployed object group.ConfigManagerProxyPropertyNotInitializedException
- if message flow information could not be determined because
the information was not supplied from the broker before a
timeout occurred.@Deprecated public MessageFlowProxy getMessageFlowByName(java.lang.String messageFlowName) throws ConfigManagerProxyPropertyNotInitializedException
getMessageFlowByName
in class DeployedObjectGroupProxy
messageFlowName
- Name of the message flow to look upConfigManagerProxyPropertyNotInitializedException
- if message flow information could not be determined because
the information was not supplied from the broker before a
timeout occurred.@Deprecated public java.util.Enumeration<MessageFlowProxy> getMessageFlows(java.util.Properties filter) throws ConfigManagerProxyPropertyNotInitializedException
getMessageFlows
in class DeployedObjectGroupProxy
filter
- Filter to select which message flows to return.
Each key is an attribute name of the required object
and each value is the required value of the attribute. A null or
empty Properties object will match all message flows directly deployed
to this deployed object group,ConfigManagerProxyPropertyNotInitializedException
- if message flow information could not be determined because
the information was not supplied from the broker before a
timeout occurred.AttributeConstants
@Deprecated public void setAllMessageFlowsRuntimeProperty(java.lang.String objectAndPropertyName, java.lang.String propertyValue) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
setAllMessageFlowsRuntimeProperty
in class DeployedObjectGroupProxy
objectAndPropertyName
- The complete object and property name of the
property being manipulatedpropertyValue
- The new value to associate with the propertyConfigManagerProxyLoggedException
- is always thrown as this
method is unsupported on a SharedLibraryProxy object.java.lang.IllegalArgumentException
- if objectAndPropertyName is not a valid syntax.@Deprecated public void setAllMessageFlowsRuntimeProperties(java.util.Properties props) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
setAllMessageFlowsRuntimeProperties
in class DeployedObjectGroupProxy
props
- A set of properties to set on all message flows owned by the object group.
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
- is always thrown as this
method is unsupported on a SharedLibraryProxy object.java.lang.IllegalArgumentException
- if objectAndPropertyName is not a valid syntax.