com.ibm.broker.config.proxy

Class WebAdminProxy



  • 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:

         BrokerProxy b = BrokerProxy.getInstance(
             new IntegrationNodeConnectionParameters("localhost", 4414)); 
         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:
     -------- ----------- -------------   ------------------------------------
    
     
    • Field Detail

      • DEFAULT_WEB_USER

        public static final java.lang.String DEFAULT_WEB_USER
        When administration security is disabled, the web interface uses a default user account which cannot be modified. This account is not available for use when security is enabled.
        See Also:
        Constant Field Values
      • DFE_PATHFINDER_WEB_USER

        public static final java.lang.String DFE_PATHFINDER_WEB_USER
        See Also:
        Constant Field Values
    • Method Detail

      • getConfigurationObjectType

        public ConfigurationObjectType getConfigurationObjectType()
        Description copied from class: AdministeredObject
        Returns the ConfigurationObjectType associated with this AdministeredObject type. For example, for ExecutionGroupProxy, ConfigurationObjectType.executiongroup is returned.
        Specified by:
        getConfigurationObjectType in class AdministeredObject
        Returns:
        ConfigurationObjectType associated with this class.
      • getConfigurationObjectTypeOfParent

        public ConfigurationObjectType getConfigurationObjectTypeOfParent()
        Description copied from class: AdministeredObject
        Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type. For example, for ExecutionGroupProxy, ConfigurationObjectType.broker is returned.
        Specified by:
        getConfigurationObjectTypeOfParent in class AdministeredObject
        Returns:
        ConfigurationObjectType associated with this class.
      • createWebUser

        public WebUserProxy createWebUser(java.lang.String userName,
                                          java.lang.String role,
                                          java.lang.String password)
                                   throws ConfigManagerProxyLoggedException,
                                          java.lang.IllegalArgumentException
        Asks the broker to create a Web User Account with the supplied username. If a web user already exists with the supplied name, the existing user is returned.

        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.

        Parameters:
        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.
        Returns:
        WebUserProxy object that represents the new web user account.
        Throws:
        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.
      • createWebUser

        public WebUserProxy createWebUser(java.lang.String userName,
                                          java.lang.String role)
                                   throws ConfigManagerProxyLoggedException,
                                          java.lang.IllegalArgumentException
        Asks the broker to create a Web User Account with the supplied username but no local password. If a web user already exists with the supplied name, the existing user is returned.

        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.

        Parameters:
        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.
        Returns:
        WebUserProxy object that represents the new web user account.
        Throws:
        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.
      • deleteWebUser

        public void deleteWebUser(java.lang.String name)
                           throws ConfigManagerProxyLoggedException,
                                  ConfigManagerProxyPropertyNotInitializedException,
                                  java.lang.IllegalArgumentException
        Asks the broker to delete the web user with the supplied name from the broker.

        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.

        Parameters:
        name - of the web user to be deleted from the broker.
        Throws:
        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.
      • setName

        public void setName(java.lang.String name)
                     throws ConfigManagerProxyLoggedException
        This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class. It is not possible to change the name of the admininistration queue.
        Overrides:
        setName in class AdministeredObject
        Parameters:
        name - (this is ignored)
        Throws:
        ConfigManagerProxyLoggedException - to indicate this method should not be called.
      • setShortDescription

        public void setShortDescription(java.lang.String desc)
                                 throws ConfigManagerProxyLoggedException
        This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class. It is not possible to change the short description of the admininistration queue.
        Overrides:
        setShortDescription in class AdministeredObject
        Parameters:
        desc - (this is ignored)
        Throws:
        ConfigManagerProxyLoggedException - to indicate this method should not be called.
      • setLongDescription

        public void setLongDescription(java.lang.String desc)
                                throws ConfigManagerProxyLoggedException
        This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class. It is not possible to change the long description of the admininistration queue.
        Overrides:
        setLongDescription in class AdministeredObject
        Parameters:
        desc - (this is ignored)
        Throws:
        ConfigManagerProxyLoggedException - to indicate this method should not be called.