public class WebAdminProxy extends AdministeredObject
This object is for Web Administration. It provides create, delete and query functionality for Web user accounts.
In order to use the WebAdminProxy object, applications must first obtain a handle to it. Here is an example of how to do this:
BrokerConnectionParameters bcp = MQBrokerConnectionParameters("localhost", 1414, "QMGR"); BrokerProxy b = BrokerProxy.getInstance(bcp); WebAdminProxy wa = b.getWebAdminProxy();
com.ibm.broker.config.proxy.WebUserProxy extends
com.ibm.broker.config.proxy.AdministeredObject
|
|
Responsibilities | Represents Web Users and allows settings to be altered or queried. |
Internal Collaborators |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_WEB_USER
When administration security is disabled, the web interface uses a default user account which
cannot be modified.
|
static java.lang.String |
DFE_PATHFINDER_WEB_USER |
Modifier and Type | Method and Description |
---|---|
WebUserProxy |
createWebUser(java.lang.String userName,
java.lang.String role,
java.lang.String password)
Asks the broker to create a Web User Account with the supplied username.
|
void |
deleteWebUser(java.lang.String name)
Asks the broker to delete the web user with
the supplied name from the broker.
|
ConfigurationObjectType |
getConfigurationObjectType()
Returns the ConfigurationObjectType associated
with this AdministeredObject type.
|
ConfigurationObjectType |
getConfigurationObjectTypeOfParent()
Returns the ConfigurationObjectType associated
with the logical parent of this AdministeredObject type.
|
WebUserProxy |
getWebUser(java.lang.String username)
Returns a WebUserProxy object which represents the named user account.
|
java.util.Enumeration<WebUserProxy> |
getWebUsers()
Returns an enumeration of all the WebUserProxy objects
|
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 |
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.
|
deregisterListener, deregisterListener, elements, equals, 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, getType, getUUID, hasBeenPopulatedByBroker, hasBeenPopulatedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByConfigManager, hasBeenRestrictedByConfigManager, hasBeenUpdatedByConfigManager, hasBeenUpdatedByConfigManager, isAwaitingSubmissionForCreation, isAwaitingSubmissionForDeletion, isDeployed, isShared, refresh, registerListener, registerListener, registerListener, setProperties, toString, toVerboseString, unsubscribeFromConfigurationManagerUpdates, withName, withUUID
public static final java.lang.String DEFAULT_WEB_USER
public static final java.lang.String DFE_PATHFINDER_WEB_USER
public ConfigurationObjectType getConfigurationObjectType()
AdministeredObject
getConfigurationObjectType
in class AdministeredObject
public ConfigurationObjectType getConfigurationObjectTypeOfParent()
AdministeredObject
getConfigurationObjectTypeOfParent
in class AdministeredObject
public java.util.Enumeration<WebUserProxy> getWebUsers() throws ConfigManagerProxyPropertyNotInitializedException
Returns an enumeration of all the WebUserProxy objects
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public WebUserProxy getWebUser(java.lang.String username) throws java.lang.IllegalArgumentException, ConfigManagerProxyPropertyNotInitializedException
username
- The userid of the Web User accountjava.lang.IllegalArgumentException
ConfigManagerProxyPropertyNotInitializedException
public WebUserProxy createWebUser(java.lang.String userName, java.lang.String role, java.lang.String password) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
If synchronous updates have been enabled using BrokerProxy.setSynchronous(), this method will only return an WebUserProxy object once the web user has been fully initialized on the broker. If synchronous updates have not been enabled, an object will be returned but it might not yet exist on the target broker at the point of return, and any subsequent operations on that object will only be attempted by the broker if and only if the actual execution group has been fully initialized.
userName
- The username for the web user account (this should be unique as it identifies the user to the broker).
This must be null or else an IllegalArgumentException will be thrown.role
- the system account which will represent the permissions available for this web user. Due to MQ restrictions,
this field cannot be longer than 12 characters. If the role is null, it will be set to the value of the userName.password
- the password for the web user.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.java.lang.IllegalArgumentException
- if the supplied name is null or the
empty string.public void deleteWebUser(java.lang.String name) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException, java.lang.IllegalArgumentException
If synchronous updates have been enabled using BrokerProxy.setSynchronous(), this method will only return once the web user has been fully deleted. Otherwise, the request to delete the web user will be processed asynchronously and the web user might still exist when the method returns.
name
- of the web user to be deleted from the broker.ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
information was not supplied from the broker before a
timeout occurred.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.java.lang.IllegalArgumentException
- if the supplied name is null or
the empty String.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.