public class ServiceFederationManagerProxy extends AdministeredObject
Single instance per execution group is retrieved by using ExecutionGroupProxy.getServiceFederationManagerProxy() Note that this will return null if Service Federation Management not configured to be enabled in the Broker.
Given that 'eg' is a connected ExecutionGroupProxy instance, then to return the ServiceFederationManagerProxy for that execution group:
ServiceFederationManagerProxy sfmProxy = eg.getServiceFederationManagerProxy();
if (null != sfmProxy) { ... }
com.ibm.broker.config.proxy.ServiceFederationManagerProxy
|
|
Responsibilities | Provides a container of all Service Federation Manager objects within an execution group, including ServiceGroupProxyItem and ServiceProxyItem. |
Internal Collaborators | com.ibm.broker.config.proxy.ExecutionGroupProxy |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ 54148.6 2009-08-11 HDMJB v7 Release
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
copyright
Deprecated.
IBM Copyright
|
protected static java.lang.String |
sccsid
Deprecated.
Build information
|
baseRetryWaitTime, LOCAL_ATTRIBUTE_IDENTIFIER, maxRetries, objectUnavailable, owningPool, potentialNewSubcomponents, propertyUpdateLock, retryWaitTimeIncrement, subcomponentsToBeSubmittedForCreationInCurrentBatch, UUID_DELIMITER
Modifier | Constructor and Description |
---|---|
protected |
ServiceFederationManagerProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop)
Deprecated.
DO NOT USE THIS CONSTRUCTOR - use
ExecutionGroupProxy.getServiceFederationManagerProxy() instead.
|
Modifier and Type | Method and Description |
---|---|
protected boolean |
areAllServiceProxyItemsInGroupRunning(java.lang.String groupName)
Deprecated.
Returns true only if all the service proxies in the passed
service proxy group name are currently running.
|
ServiceGroupProxyItem |
createServiceGroupProxyItem(java.lang.String groupProxyName,
java.util.Properties suppliedProps)
Deprecated.
|
protected ServiceProxyItem |
createServiceProxyItem(ServiceGroupProxyItem owningGroup,
java.lang.String proxyName,
java.util.Properties suppliedProps)
Deprecated.
Creates a ServiceProxyItem in the execution group.
|
protected ServiceGroupProxyItem |
decodeServiceGroupProxyItemFromString(java.lang.String encodedData)
Deprecated.
Returns a ServiceGroupProxyItem object that contains the
information described in the encoded String.
|
protected ServiceProxyItem |
decodeServiceProxyItemFromString(java.lang.String encodedData)
Deprecated.
Returns a new ServiceProxyItem object that contains the
information described in the encoded String.
|
protected void |
delete(ServiceGroupProxyItem groupToDelete)
Deprecated.
DO not call this method directly, instead to Delete a Service
Proxy Group Item, use
ServiceGroupProxyItem.delete()
|
protected void |
delete(ServiceProxyItem spi)
Deprecated.
Asks the Broker to delete the passed ServiceProxyItem in the
passed ServiceGroupProxyItem
Application should not call this method, and should instead use
ServiceProxyItem.delete()
|
ConfigurationObjectType |
getConfigurationObjectType()
Deprecated.
Returns the ConfigurationObjectType associated
with this AdministeredObject type.
|
ConfigurationObjectType |
getConfigurationObjectTypeOfParent()
Deprecated.
Returns the ConfigurationObjectType associated
with the logical parent of this AdministeredObject type.
|
java.lang.String |
getName()
Deprecated.
Returns the name of the object
|
java.lang.String |
getRuntimeProperty(java.lang.String objectAndPropertyName)
Deprecated.
Returns the value of the runtime property with the supplied name.
|
java.lang.String[] |
getRuntimePropertyNames()
Deprecated.
Returns a string array of all runtime properties
associated with this object.
|
ServiceGroupProxyItem |
getServiceGroupProxyItemByName(java.lang.String groupProxyItemName)
Deprecated.
|
ServiceGroupProxyItem |
getServiceGroupProxyItemByUuid(java.lang.String groupProxyItemUuid)
Deprecated.
|
java.util.Enumeration<ServiceGroupProxyItem> |
getServiceGroupProxyItems()
Deprecated.
|
protected ServiceProxyItem |
getServiceProxyItemByNameInGroup(java.lang.String proxyName,
java.lang.String groupName)
Deprecated.
Returns the ServiceGroupProxyItem object with the supplied group
and proxy name, or null if a ServiceProxyItem of the supplied name
could not be found.
|
protected java.util.Enumeration<ServiceProxyItem> |
getServiceProxyItemsForGroup(java.lang.String groupName)
Deprecated.
Returns enumeration of ServiceGroupProxyItem objects in a group
Applications should not call this method and should instead use
ServiceGroupProxyItem.getServiceProxyItems().
|
void |
setLongDescription(java.lang.String desc)
Deprecated.
This method overrides the base class
implementation, so that an exception is thrown if this method
is invoked against this class.
|
void |
setProperties(java.util.Properties suppliedProps)
Deprecated.
Asks the broker to sets multiple
ServiceFederationManagerProxy properties in single request to
the broker.
|
void |
setRuntimeProperty(java.lang.String objectAndPropertyName,
java.lang.String propertyValue)
Deprecated.
Asks the broker to configure an arbitrary service federation
manager property.
|
void |
setShortDescription(java.lang.String desc)
Deprecated.
This method overrides the base class
implementation, so that an exception is thrown if this method
is invoked against this class.
|
java.lang.String |
toString()
Deprecated.
Displays the name of the current object.
|
checkTypeAndBase64DecodePropertyValue, checkTypeAndBase64EncodePropertyValue, clearPredictedNewSubcomponents, createManagedSubcomponent, createManagedSubcomponent, createManagedSubcomponent, createManagedSubcomponent, deleteManagedSubcomponents, deregisterListener, deregisterListener, elements, equals, execute, getAdvancedProperties, getAdvancedProperties, getBasicProperties, getBasicProperties, getGrandParentUUIDProperties, getLastBIPMessages, getLastCompletionCode, getLastUpdateUser, getLongDescription, getManagedSubcomponent, getManagedSubcomponentFromStringRepresentation, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponentsAsStrings, getManagedSubcomponentsAsStrings, 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, setName, setProperties, setRefreshRequired, setTimeOfLastUpdate, toVerboseString, unsubscribeFromConfigurationManagerUpdates, validateObjectAndPropertyName, validateServiceObjectAndPropertyName, withName, withUUID
protected static final java.lang.String copyright
protected static final java.lang.String sccsid
protected ServiceFederationManagerProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop)
aop
- The pool that will own this object.public ConfigurationObjectType getConfigurationObjectType()
getConfigurationObjectType
in class AdministeredObject
public ConfigurationObjectType getConfigurationObjectTypeOfParent()
getConfigurationObjectTypeOfParent
in class AdministeredObject
public java.lang.String getName() throws ConfigManagerProxyPropertyNotInitializedException
getName
in class AdministeredObject
ConfigManagerProxyPropertyNotInitializedException
- if the name could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.lang.String toString()
toString
in class AdministeredObject
public void setShortDescription(java.lang.String desc) throws ConfigManagerProxyLoggedException
setShortDescription
in class AdministeredObject
desc
- (this is ignored)ConfigManagerProxyLoggedException
- to indicate this
method should not be called.public void setLongDescription(java.lang.String desc) throws ConfigManagerProxyLoggedException
setLongDescription
in class AdministeredObject
desc
- (this is ignored)ConfigManagerProxyLoggedException
- to indicate this
method should not be called.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 void setRuntimeProperty(java.lang.String objectAndPropertyName, java.lang.String propertyValue) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
To set properties the objectAndPropertyName parameter must also 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* of mqsichangeproperties. For example, "This/maxWaitTime" would request a change to the Service Federation Managers maxWaitTime property. The '/' separator is defined as AttributeConstants.OBJECT_NAME_DELIMITER.
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 ServiceGroupProxyItem createServiceGroupProxyItem(java.lang.String groupProxyName, java.util.Properties suppliedProps) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
groupProxyName
- suppliedProps
- ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. 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. The user can override the timeout via BrokerProxy.setSynchronous(t)ConfigManagerProxyPropertyNotInitializedException
protected void delete(ServiceGroupProxyItem groupToDelete) throws ConfigManagerProxyLoggedException
groupToDelete
- ConfigManagerProxyLoggedException
public void setProperties(java.util.Properties suppliedProps) throws ConfigManagerProxyLoggedException
setProperties
in class AdministeredObject
suppliedProps
- Object containing the key/value pair
of properties to set.ConfigManagerProxyLoggedException
- 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.public java.util.Enumeration<ServiceGroupProxyItem> getServiceGroupProxyItems() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
public ServiceGroupProxyItem getServiceGroupProxyItemByUuid(java.lang.String groupProxyItemUuid) throws ConfigManagerProxyPropertyNotInitializedException
groupProxyItemUuid
- ConfigManagerProxyPropertyNotInitializedException
public ServiceGroupProxyItem getServiceGroupProxyItemByName(java.lang.String groupProxyItemName) throws ConfigManagerProxyPropertyNotInitializedException
groupProxyItemName
- ConfigManagerProxyPropertyNotInitializedException
protected ServiceGroupProxyItem decodeServiceGroupProxyItemFromString(java.lang.String encodedData)
encodedData
- String as stored in the relevant attribute of
the ServiceFederationManager.protected ServiceProxyItem createServiceProxyItem(ServiceGroupProxyItem owningGroup, java.lang.String proxyName, java.util.Properties suppliedProps) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
owningGroup
- group that owns the ServiceProxyItemproxyName
- Name of the ServiceProxyItemsuppliedProps
- Any properties that the ServiceProxyItem should haveConfigManagerProxyLoggedException
- If the request to create the
ServiceProxyItem could not be sent to the broker.ConfigManagerProxyPropertyNotInitializedException
- if information
was not supplied from the broker before a timeout occurred.protected ServiceProxyItem getServiceProxyItemByNameInGroup(java.lang.String proxyName, java.lang.String groupName) throws ConfigManagerProxyPropertyNotInitializedException
proxyName
- Name of the proxygroupName
- Group name assigned to the proxyConfigManagerProxyPropertyNotInitializedException
- if information
was not supplied from the broker before a timeout occurred.protected java.util.Enumeration<ServiceProxyItem> getServiceProxyItemsForGroup(java.lang.String groupName) throws ConfigManagerProxyPropertyNotInitializedException
groupName
- Group name for the proxy.ConfigManagerProxyPropertyNotInitializedException
- if information
was not supplied from the broker before a timeout occurred.protected boolean areAllServiceProxyItemsInGroupRunning(java.lang.String groupName) throws ConfigManagerProxyPropertyNotInitializedException, ConfigManagerProxyLoggedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the run state could not be determined from
the broker before a timeout occurred.ConfigManagerProxyPropertyLoggedException
- if the
request could not be sent to the broker.ConfigManagerProxyLoggedException
protected void delete(ServiceProxyItem spi) throws ConfigManagerProxyLoggedException
spi
- Object to deleteConfigManagerProxyPropertyLoggedException
- if the
request could not be sent to the broker.ConfigManagerProxyLoggedException
protected ServiceProxyItem decodeServiceProxyItemFromString(java.lang.String encodedData) throws ConfigManagerProxyPropertyNotInitializedException
encodedData
- String as stored in the relevant attribute of
the ServiceFederationManager.ConfigManagerProxyPropertyNotInitializedException