public class AdminQueueEntry extends AdministeredObject
The AdminQueueEntry class represents an entry in the brokers administration work queue.
com.ibm.broker.config.proxy.AdminQueueEntry
|
|
Responsibilities | Represents a single read-only entry from the Administration queue. |
Internal Collaborators | None |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ 51619.40 2009-05-26 HDCAB v7 Release 3779 2012-05-10 HDCAB v8 Release - Converted to an AdministeredObject
Modifier and Type | Method and Description |
---|---|
void |
cancel(AdminQueueProxy owningProxy)
Removes the administration queue entry from the
administration queue that matches the work identifier.
|
void |
deregisterListener(AdministeredObjectListener listener)
Asks the IBM Integration API (CMP) to unsubscribe a
previously registered AdministeredObjectListener, given the
listener instance that was supplied during registration.
|
void |
deregisterListener(AdvancedAdministeredObjectListener listener)
Asks the IBM Integration API (CMP) to unsubscribe a
previously registered AdvancedAdministeredObjectListener,
given the listener instance that was supplied during
registration.
|
boolean |
equals(java.lang.Object obj)
Compares this AdministeredObject with the Object passed in.
|
static AdminQueueEntry |
getAdminQueueEntryFromString(java.lang.String encodedData)
Returns a new AdminQueueEntry object that contains the
information described in the encoded String.
|
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.Date |
getCreationTimestamp()
Returns the creationTimestamp field for the current
administration queue work entry
|
java.lang.String |
getDescription()
Returns the description field for the current administration queue work entry.
|
java.util.Date |
getLastStatusChangeTimestamp()
Returns the lastStatusChangeTimestamp field for the current
administration queue work entry
|
java.lang.String |
getObjectName()
Returns the affectedObject field for the current
administration queue work entry.
|
ConfigurationObjectType |
getObjectType()
Returns the affectedObjectType field for the current
administration queue work entry.
|
OperationType |
getOperationType()
Returns the operationType field for the current
administration queue work entry.
|
java.lang.String |
getParentName()
Returns the parentObject field for the current
administration queue work entry.
|
ConfigurationObjectType |
getParentType()
Returns the parentObjectType field for the current
administration queue work entry.
|
java.lang.String |
getResponse()
Returns the response returned from the run-time as a result
of this request.
|
java.util.Properties |
getResponseAsProperties()
Returns a Properties object representing the response
returned from the run-time as a result of this request.
|
CompletionCodeType |
getStatus()
Returns the status field for the current administration queue
work entry.
|
java.lang.String |
getType()
Convenience method to return the type of this administered object.
|
java.lang.String |
getUser()
Returns the user field for the current administration
queue work entry.
|
java.lang.String |
getWorkIdentifier()
Returns the work identifier field for the current
administration queue work entry
|
boolean |
hasBeenCompletedByBroker(boolean waitIfNotUpdated)
Returns true if and only if this AdminQueueEntry has received
a completion code that indicates that the request is
complete.
|
void |
refresh()
Forces this AdministeredObject to reregister
itself with the broker and to re-receive
the object's complete set of attributes.
|
void |
registerListener(AdministeredObjectListener listener)
Asks the broker to keep the caller informed of any changes to the
current AdministeredObject.
|
void |
registerListener(AdvancedAdministeredObjectListener listener)
Asks the broker to keep the caller informed of any changes to the
current AdministeredObject.
|
void |
registerListener(AdvancedAdministeredObjectListener listener,
boolean sendNotificationImmediately,
java.lang.Object nextNotificationCorrelationID)
Asks the broker to keep the caller informed of any changes to the
current AdministeredObject, and ask to be provided with advanced
notifications.
|
void |
setLongDescription(java.lang.String desc)
This method overrides the base class
implementation, so that an exception is thrown if this method
is invoked against this class.
|
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 |
setProperties(java.util.Properties suppliedProps)
This method overrides the base class
implementation, so that an exception is thrown if this method
is invoked against this class.
|
void |
setShortDescription(java.lang.String desc)
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()
Displays information on the Administration queue entry (for
trace)
|
elements, getAdvancedProperties, getBasicProperties, getLastBIPMessages, getLastCompletionCode, getLastUpdateUser, getLongDescription, getManagedSubcomponent, getManagedSubcomponentFromStringRepresentation, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponentsAsStrings, getManagedSubcomponentsAsStrings, getName, getNumberOfSubcomponents, getParent, getProperties, getProperty, getProperty, getProperty, getProperty, getRepositoryTimestamp, getShortDescription, getTimeOfLastCompletionCode, getTimeOfLastUpdate, getUUID, hasBeenPopulatedByBroker, hasBeenPopulatedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByConfigManager, hasBeenRestrictedByConfigManager, hasBeenUpdatedByConfigManager, hasBeenUpdatedByConfigManager, isAwaitingSubmissionForCreation, isAwaitingSubmissionForDeletion, isDeployed, isShared, toVerboseString, unsubscribeFromConfigurationManagerUpdates, withName, withUUID
public ConfigurationObjectType getConfigurationObjectType()
getConfigurationObjectType
in class AdministeredObject
public ConfigurationObjectType getConfigurationObjectTypeOfParent()
getConfigurationObjectTypeOfParent
in class AdministeredObject
public java.lang.String getWorkIdentifier()
public java.util.Date getCreationTimestamp()
public java.util.Date getLastStatusChangeTimestamp()
public CompletionCodeType getStatus()
public java.lang.String getDescription()
public java.lang.String getUser()
public OperationType getOperationType()
public java.lang.String getObjectName()
public ConfigurationObjectType getObjectType()
public java.lang.String getParentName()
public ConfigurationObjectType getParentType()
public java.lang.String getResponse() throws ConfigManagerProxyPropertyNotInitializedException, ConfigManagerProxyLoggedException
ConfigManagerProxyPropertyNotInitializedException
- if
the run-time response is not available.ConfigManagerProxyLoggedException
- if the
run-time response could not be converted to a stringpublic java.util.Properties getResponseAsProperties() throws ConfigManagerProxyPropertyNotInitializedException, ConfigManagerProxyLoggedException
ConfigManagerProxyPropertyNotInitializedException
- if
the run-time response is not available.ConfigManagerProxyLoggedException
- if the
run-time response could not be converted to a stringpublic java.lang.String toString()
toString
in class AdministeredObject
public boolean equals(java.lang.Object obj)
Two instances of an AdministeredObject are equal if and only if they are both AdministeredObjects and they have the same ConfigurationObjectType and UUID.
equals
in class AdministeredObject
obj
- - the object that is to be compared with this one.public static AdminQueueEntry getAdminQueueEntryFromString(java.lang.String encodedData)
encodedData
- String as stored in the
relevant attribute of the AdminQueueProxy.public void cancel(AdminQueueProxy owningProxy) throws ConfigManagerProxyLoggedException
owningProxy
- Proxy that can be used to route
the delete request to the Broker.ConfigManagerProxyLoggedException
- if the request to
cancel the administration queue entry was unsuccessful.
Asks the Configuration Manager to delete the supplied
subscription.public boolean hasBeenCompletedByBroker(boolean waitIfNotUpdated)
waitIfNotUpdated
- If set to true, this method
will retry for the currently configured timeout
period if the request has not been completed. If the request
has not been completed after the timeout period has expired,
false will be returned.BrokerProxy.setRetryCharacteristics(long)
public void registerListener(AdministeredObjectListener listener)
The listener will only be invoked after a message from the broker is received by the IBM Integration API (CMP) that states the current object has been modified or deleted, or if a previous action involving this object and originated by this application has been completed.
In order to register listeners against multiple AdministeredObjects, user applications must call registerListener() for each object for which it wishes to receive notifications.
registerListener
in class AdministeredObject
listener
- the object that will be notified of any events
on the current AdministeredObject.public void registerListener(AdvancedAdministeredObjectListener listener, boolean sendNotificationImmediately, java.lang.Object nextNotificationCorrelationID)
Most applications will not need to use the information provided by the AdvancedAdministeredObjectListener and should therefore not call this method to register their listeners. Use registerListener(AdministeredObjectListener) if possible.
The listener will only be invoked after a message from the broker is received by the IBM Integration API (CMP) that states the current object has been modified or deleted, or if a previous action involving this object and originated by this application has been completed.
In order to register listeners against multiple AdministeredObjects, user applications must call registerListener() for each object for which it wishes to receive notifications.
Each AdvancedAdministeredObjectListener instance can have at most one correlationID for each AdministeredObject for which it is registered.
Note: If the caller sets sendNotificationImmediately to false AND the object has not yet received its complete set of attributes from the broker, this method will pause until the complete attribute list has been provided; this is done in order to establish a viable baseline from which 'changed attributes' list can be calculated. In this case, if the complete attribute list is not provided by the time the configured timeout occurs, the first processModify() message for this object may include the complete set of attributes for the AdministeredObject when the attribute list finally does arrive.
registerListener
in class AdministeredObject
listener
- the object that will be notified of any eventssendNotificationImmediately
- If false, processModify()
will only ever be called upon receipt of a modification message from the
broker. If true, the method will additionally
be called as soon as the listener is registered. This special notification
will contain information on all of the object's attributes.nextNotificationCorrelationID
- This is used to group together
listeners that share notification information. Specifically, when a
'modify' or 'delete' notification occurs, advanced listeners are told an
approximate time till the next notification to a listener
with the same correlation identifier is expected.
Specify null here to not use a correlation identifier for this listener.public void registerListener(AdvancedAdministeredObjectListener listener)
The listener will only be invoked after a message from the broker is received by the IBM Integration API (CMP) that states the current object has been modified or deleted, or if a previous action involving this object and originated by this application has been completed.
In order to register listeners against multiple AdministeredObjects, user applications must call registerListener() for each object for which it wishes to receive notifications.
After a successful completion of this call, no "object modified" notification will be sent to the listener until the next time a modification happens to occur on the object. Listeners that wish to receive an immediate notification (e.g. to provide a baseline for any future deltas) must call registerListener(listener, true, *) instead.
registerListener
in class AdministeredObject
listener
- the object that will be notified of any events
on the current AdministeredObject.public void deregisterListener(AdministeredObjectListener listener)
If the supplied listener was registered with this AdministeredObject more than once, all registrations will be removed.
If the supplied listener has not been registered with this administered object then this method does nothing.
deregisterListener
in class AdministeredObject
listener
- the object that will no longer be notified of any eventspublic void deregisterListener(AdvancedAdministeredObjectListener listener)
If the supplied listener was registered with this AdministeredObject more than once, all registrations will be removed.
If the supplied listener has not been registered with this administered object then this method does nothing.
deregisterListener
in class AdministeredObject
listener
- the object that will no longer be notified of any eventspublic void setProperties(java.util.Properties suppliedProps) throws ConfigManagerProxyLoggedException
setProperties
in class AdministeredObject
suppliedProps
- the properties that the caller wishes to set.ConfigManagerProxyLoggedException
- to indicate this
method should not be called.public java.lang.String getType()
getType
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 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 void refresh() throws ConfigManagerProxyLoggedException
This method must not be called on AdministeredObject instances that do not yet exist on the broker (ie. objects initialized during a batch of creation requests).
refresh
in class AdministeredObject
ConfigManagerProxyLoggedException
- if the request
to refresh the object could not be sent to the
broker.