public class ServiceGroupProxyItem
extends java.lang.Object
Instances are created or retrieved from an execution group's ServiceFederationManagerProxy and are not modified by the CMP once they have been instantiated. If any Service Federation Management objects or properties are subsequently modified, change notifications will only be sent to AdministeredObjectListeners of the ServiceFederationManagerProxy, and this object will contain out-of-date information. At this point this object should be re-obtained.
Given that 'sfmp' is a ServiceFederationManagerProxy obtain from a connected ExecutionGroupProxy instance, then to create a new ServiceGroupProxyItem instance use:
ServiceGroupProxyItem sgpi = sfmp.createServiceGroupProxy(...);To retrieve an enumeration of all the ServiceGroupProxyItem objects:
EnumerationTo retrieve a named ServiceGroupProxyItem object use:sgpis = sfmp.getServiceGroupProxys();
ServiceGroupProxyItem sgpi = sfmp.getServiceGroupProxyByName(groupProxyName);
com.ibm.broker.config.proxy.ServiceGroupProxyItem | |
Responsibilities | Provides a Service Federation Management "Service Group Proxy" Item holding the properties of the Group and providing methods for creating and managing contained "Service Proxy" Items. |
Internal Collaborators | com.ibm.broker.config.proxy.ServiceFederationManager |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ 54148.n 2009-08-05 HDMJB v7 Release
Modifier and Type | Method and Description |
---|---|
ServiceProxyItem |
createServiceProxyItem(java.lang.String proxyName,
java.util.Properties suppliedProps)
Asks the broker to create a ServiceProxyItem of the supplied
groupProxyName, with the passed properties in the Execution Group
owning this ServiceGroupProxyItem.
|
void |
delete()
Asks the broker to delete this ServiceGroupProxyItem
Note that deleting a ServiceGroupProxyItem implicitly deletes
all ServiceProxyItems belonging to this group, and stops and
removes their service proxy in the runtime
|
java.lang.String |
getAuthor()
Returns the Author of the Service Group Proxy Item
|
java.util.Date |
getCreated()
Returns the time when this Service Group Proxy Item was
created in the runtime.
|
java.util.Date |
getLastUpdated()
Returns the time when this Service Group Proxy Item was last
updated in the runtime.
|
java.lang.String |
getName()
Returns the Name of the Service Group Proxy Item
|
java.lang.String |
getSecured()
Returns the secured property of this Service Group Proxy Item as one
of SFM_ITEM_SECURED_INSECURE, SFM_ITEM_SECURED_SECURE or
SFM_ITEM_SECURED_ASTARGET as defined in AttributeConstants
|
ServiceProxyItem |
getServiceProxyItemByName(java.lang.String proxyName)
Returns the ServiceProxyItem object with the supplied groupProxyName, or
null if an ServiceGroupProxyItem of that groupProxyName does not exist in this
ServiceGroupProxyItem or if the supplied argument was null
|
java.util.Enumeration<ServiceProxyItem> |
getServiceProxyItems()
Returns an enumeration of all the ServiceProxyItem objects in this
ServiceGroupProxyItem
|
java.lang.String |
getSummary()
Returns the Summary of the Service Group Proxy Item
|
java.lang.String |
getTitle()
Returns the Title of the Service Group Proxy Item
|
java.lang.String |
getUUID()
Returns the UUID Summary of the Service Group Proxy Item
|
boolean |
isRunEnabled()
Returns true only if the service group proxy item is set to
run when the broker is started.
|
boolean |
isRunning()
Returns true only if all the service proxies in this service
proxy group are currently running.
|
boolean |
isValidating()
Returns true if this Service Group Proxy Item is validating,
and false if it is not.
|
void |
setAdminState(boolean newState)
Sets the adminState of the ServiceGroupProxyItem to the
specified new value.
|
void |
setAuthor(java.lang.String newValue)
Sets the author field of the current ServiceGroupProxyItem.
|
void |
setProperties(java.util.Properties suppliedProps)
Asks the broker to sets multiple ServiceGroupProxy properties
in single request to the broker.
|
void |
setSummary(java.lang.String newValue)
Sets the summary field of the current ServiceGroupProxyItem.
|
void |
setTitle(java.lang.String newValue)
Sets the title field of the current ServiceGroupProxyItem.
|
void |
start()
Sets the adminState of the ServiceGroupProxyItem to true.
|
void |
stop()
Sets the adminState of the ServiceGroupProxyItem to false.
|
java.lang.String |
toString()
Displays the name of the current object.
|
public void delete() throws ConfigManagerProxyLoggedException
ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker.public void start() throws ConfigManagerProxyLoggedException
ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker.public void stop() throws ConfigManagerProxyLoggedException
ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker.public void setProperties(java.util.Properties suppliedProps) throws ConfigManagerProxyLoggedException
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 ServiceProxyItem createServiceProxyItem(java.lang.String proxyName, java.util.Properties suppliedProps) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
proxyName
- Name of the service proxysuppliedProps
- Additional properties for the service proxyConfigManagerProxyLoggedException
- if the request could not be
sent to the broker.ConfigManagerProxyPropertyNotInitializedException,
- ConfigManagerProxyLoggedExceptionConfigManagerProxyPropertyNotInitializedException
public java.util.Enumeration<ServiceProxyItem> getServiceProxyItems() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
public ServiceProxyItem getServiceProxyItemByName(java.lang.String proxyName) throws ConfigManagerProxyPropertyNotInitializedException
proxyName
- ConfigManagerProxyPropertyNotInitializedException
public java.lang.String getName()
public java.lang.String getUUID()
public java.lang.String getTitle()
public java.lang.String getAuthor()
public java.lang.String getSummary()
public boolean isRunEnabled()
public boolean isRunning() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the run state could not be determined from
the broker.public java.lang.String getSecured()
public boolean isValidating()
public java.util.Date getCreated()
public java.util.Date getLastUpdated()
public java.lang.String toString()
toString
in class java.lang.Object
public void setTitle(java.lang.String newValue) throws ConfigManagerProxyLoggedException
newValue
- New value string.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 void setAuthor(java.lang.String newValue) throws ConfigManagerProxyLoggedException
newValue
- New value string.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 void setSummary(java.lang.String newValue) throws ConfigManagerProxyLoggedException
newValue
- New value string.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 void setAdminState(boolean newState) throws ConfigManagerProxyLoggedException
ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker.