public class WebUserProxy extends AdministeredObject
This object represents a user account for Web Administration. Each account has password, role and profile information, all of which is available through this IBM Integration API (CMP) object.
In order to use the WebUserProxy object, applications must first obtain
a handle to it from the WebAdminProxy
. Here is an example of how to do this:
BrokerProxy b = BrokerProxy.getInstance( new IntegrationNodeConnectionParameters("localhost", 4414)); WebAdminProxy wa = b.getWebAdminProxy(); WebUserProxy wup = wa.getWebUser("myuserid"); or: Enumerationwups = wa.getWebUsers(); while(wups.hasMoreElements()) { WebUserProxy wup = wups.nextElement(); ... }
com.ibm.broker.config.proxy.WebUserProxy
|
|
Responsibilities | Represents a single entry from the web user table. |
Internal Collaborators | None |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
copyright
IBM Copyright
|
protected static java.lang.String |
sccsid
Version information
|
protected static java.lang.String |
WEBUSER_CURRENT_VERSION |
baseRetryWaitTime, LOCAL_ATTRIBUTE_IDENTIFIER, maxRetries, objectUnavailable, owningPool, potentialNewSubcomponents, propertyUpdateLock, retryWaitTimeIncrement, subcomponentsToBeSubmittedForCreationInCurrentBatch, UUID_DELIMITER
Modifier | Constructor and Description |
---|---|
protected |
WebUserProxy(com.ibm.broker.config.proxy.AdministeredObjectPool parent)
DO NOT USE THIS CONSTRUCTOR
|
Modifier and Type | Method and Description |
---|---|
void |
changePassword(java.lang.String newPassword)
Changes the password for the user.
|
void |
changePassword(java.lang.String oldPassword,
java.lang.String newPassword)
Changes the password for the user.
|
protected static java.lang.String |
encodePassword(java.lang.String clearText) |
java.util.Properties |
getAuthPermissions()
Retrieves a list of the current authorisations available to this web user.
|
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.lang.String |
getName()
Returns the username associated with this web user.
|
java.util.Properties |
getProfileProperties()
Returns the role which this user performs.
|
java.lang.String |
getRole()
Returns the role which this user performs.
|
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 |
setProfileProperty(java.lang.String propertyName,
java.lang.String propertyValue)
Sets a profile property for the user.
|
void |
setRole(java.lang.String newRole)
Changes the role for the user.
|
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.
|
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, setProperties, setProperties, setRefreshRequired, setTimeOfLastUpdate, toString, toVerboseString, unsubscribeFromConfigurationManagerUpdates, validateObjectAndPropertyName, validateServiceObjectAndPropertyName, withName, withUUID
protected static final java.lang.String copyright
protected static final java.lang.String sccsid
protected static final java.lang.String WEBUSER_CURRENT_VERSION
protected WebUserProxy(com.ibm.broker.config.proxy.AdministeredObjectPool parent)
parent
- The parent that will own this object.public ConfigurationObjectType getConfigurationObjectType()
AdministeredObject
getConfigurationObjectType
in class AdministeredObject
public ConfigurationObjectType getConfigurationObjectTypeOfParent()
AdministeredObject
getConfigurationObjectTypeOfParent
in class AdministeredObject
public java.lang.String getRole() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
public java.util.Properties getProfileProperties() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
public void setProfileProperty(java.lang.String propertyName, java.lang.String propertyValue) throws ConfigManagerProxyLoggedException
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.lang.String getName() throws ConfigManagerProxyPropertyNotInitializedException
getName
in class AdministeredObject
ConfigManagerProxyPropertyNotInitializedException
public void changePassword(java.lang.String oldPassword, java.lang.String newPassword) throws ConfigManagerProxyLoggedException
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.Properties getAuthPermissions() throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker, or (only if synchronous updates have been enabled)
the request was not successfully processed by the broker.ConfigManagerProxyRequestTimeoutException
- if synchronous updates
have been enabled and a response was not received by the broker before
a timeout occurred. (Note that this exception type extends
ConfigManagerProxyLoggedException).ConfigManagerProxyRequestFailureException
- if synchronous updates
have been enabled and the request was rejected by the broker.
(Note that this exception type extends ConfigManagerProxyLoggedException).ConfigManagerProxyPropertyNotInitializedException
public void changePassword(java.lang.String newPassword) throws ConfigManagerProxyLoggedException
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.protected static final java.lang.String encodePassword(java.lang.String clearText) throws ConfigManagerProxyLoggedException
public void setRole(java.lang.String newRole) throws ConfigManagerProxyLoggedException
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 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 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.