javax.slee.management
Interface ProfileProvisioningMBean


public interface ProfileProvisioningMBean

The ProfileProvisiningMBean interface defines management operations for creating, removing, and interacting with profiles and profile tables.

The Object Name of a ProfileProvisioningMBean object can be obtained by a management client via the SleeManagementMBean.getProfileProvisioningMBean() method.


Method Summary
 javax.management.ObjectName createProfile(java.lang.String profileTableName, java.lang.String newProfileName)
          Create a new profile with the specified name in the specified profile table.
 void createProfileTable(ProfileSpecificationID id, java.lang.String newProfileTableName)
          Create a new profile table from a profile specification.
 javax.management.ObjectName getDefaultProfile(java.lang.String profileTableName)
          Get the JMX Object Name of the default profile for a profile table.
 javax.management.ObjectName getProfile(java.lang.String profileTableName, java.lang.String profileName)
          Get the JMX Object Name of a profile.
 java.util.Collection getProfiles(java.lang.String profileTableName)
          Get a collection of ProfileID objects that identify all the profiles contained in a specified profile table.
 java.util.Collection getProfilesByIndexedAttribute(java.lang.String profileTableName, java.lang.String attributeName, java.lang.Object attributeValue)
          Get a collection of ProfileID objects that identify the profiles contained in a specified profile table where a specified profile attribute is set to a specified value.
 ProfileSpecificationID getProfileSpecification(java.lang.String profileTableName)
          Get the component identifier of the profile specification that a profile table was created with.
 java.util.Collection getProfileTables()
          Get a collection of java.lang.String objects that identify the names of all the profile tables that have been created in the SLEE.
 void removeProfile(java.lang.String profileTableName, java.lang.String profileName)
          Remove a profile from a profile table.
 void removeProfileTable(java.lang.String profileTableName)
          Remove a profile table.
 void renameProfileTable(java.lang.String oldProfileTableName, java.lang.String newProfileTableName)
          Rename a profile table.
 

Method Detail

createProfileTable

public void createProfileTable(ProfileSpecificationID id,
                               java.lang.String newProfileTableName)
                        throws java.lang.NullPointerException,
                               UnrecognizedProfileSpecificationException,
                               InvalidArgumentException,
                               ProfileTableAlreadyExistsException,
                               ManagementException
Create a new profile table from a profile specification.
Parameters:
id - the component identifier of the profile specification that the profile table should be created from.
newProfileTableName - the name of the profile table to create. The name cannot include the '/' character.
Throws:
java.lang.NullPointerException - if newProfileTableName is null.
UnrecognizedProfileSpecificationException - if id is not a recognizable ProfileSpecificationID for the SLEE or it does not correspond with a profile specification installed in the SLEE.
InvalidArgumentException - if newProfileTableName is zero-length or contains a '/' character.
ProfileTableAlreadyExistsException - if a profile table with the same name already exists.
ManagementException - if the profile table could not be created due to a system-level failure.

removeProfileTable

public void removeProfileTable(java.lang.String profileTableName)
                        throws java.lang.NullPointerException,
                               UnrecognizedProfileTableNameException,
                               ManagementException
Remove a profile table.
Parameters:
profileTableName - the name of the profile table to remove.
Throws:
java.lang.NullPointerException - if profileTableName is null.
UnrecognizedProfileTableNameException - if a profile table with the specified name does not exist.
ManagementException - if the profile table could not be removed due to a system-level failure.

getProfileSpecification

public ProfileSpecificationID getProfileSpecification(java.lang.String profileTableName)
                                               throws java.lang.NullPointerException,
                                                      UnrecognizedProfileTableNameException,
                                                      ManagementException
Get the component identifier of the profile specification that a profile table was created with.
Parameters:
profileTableName - the name of the profile table.
Returns:
the component identifier of the profile specification that the profile table was created with.
Throws:
java.lang.NullPointerException - if profileTableName is null.
UnrecognizedProfileTableNameException - if a profile table with the specified name does not exist.
ManagementException - if the component identifier could not be obtained due to a system-level failure.

renameProfileTable

public void renameProfileTable(java.lang.String oldProfileTableName,
                               java.lang.String newProfileTableName)
                        throws java.lang.NullPointerException,
                               UnrecognizedProfileTableNameException,
                               InvalidArgumentException,
                               ProfileTableAlreadyExistsException,
                               ManagementException
Rename a profile table.
Parameters:
oldProfileTableName - the name of the profile table to rename.
newProfileTableName - the new name for the profile table.
Throws:
java.lang.NullPointerException - if either argument is null.
UnrecognizedProfileTableNameException - if a profile table with the name oldProfileTableName does not exist.
InvalidArgumentException - if newProfileTableName is zero-length or contains a '/' character.
ProfileTableAlreadyExistsException - if a profile table with the same name as newProfileTableName already exists.
ManagementException - if the profile table could not be renamed due to a system-level failure.

getDefaultProfile

public javax.management.ObjectName getDefaultProfile(java.lang.String profileTableName)
                                              throws java.lang.NullPointerException,
                                                     UnrecognizedProfileTableNameException,
                                                     ManagementException
Get the JMX Object Name of the default profile for a profile table. Every profile table has one default profile. New profiles created in a profile table obtain their intial values from the default profile.
Parameters:
profileTableName - the name of the profile table.
Returns:
the Object Name of the default profile for the specified profile table.
Throws:
java.lang.NullPointerException - if profileTableName is null.
UnrecognizedProfileTableNameException - if a profile table with the specified name does not exist.
ManagementException - if the Object Name could not be obtained due to a system-level failure.

createProfile

public javax.management.ObjectName createProfile(java.lang.String profileTableName,
                                                 java.lang.String newProfileName)
                                          throws java.lang.NullPointerException,
                                                 UnrecognizedProfileTableNameException,
                                                 InvalidArgumentException,
                                                 ProfileAlreadyExistsException,
                                                 ManagementException
Create a new profile with the specified name in the specified profile table. The ObjectName returned by this method provides the management client with the name of a Profile MBean for the created profile. This Profile MBean is in the read-write state allowing the management client a chance to configure the initial values for the profile attributes before it is added to the profile table. The new profile is not visible in the profile table until the Profile MBean state is committed.
Parameters:
profileTableName - the name of the profile table to create the profile in.
newProfileName - the name of the new profile. The name must be unique within the scope of the profile table.
Returns:
the Object Name of the new profile.
Throws:
java.lang.NullPointerException - if either argument is null.
UnrecognizedProfileTableNameException - if a profile table with the specified name does not exist.
InvalidArgumentException - if newProfileName is zero-length.
ProfileAlreadyExistsException - if a profile with the same name already exists in the profile table.
ManagementException - if the profile could not be created due to a system-level failure.

removeProfile

public void removeProfile(java.lang.String profileTableName,
                          java.lang.String profileName)
                   throws java.lang.NullPointerException,
                          UnrecognizedProfileTableNameException,
                          UnrecognizedProfileNameException,
                          ManagementException
Remove a profile from a profile table.
Parameters:
profileTableName - the name of the profile table to remove the profile from.
profileName - the name of the profile to remove.
Throws:
java.lang.NullPointerException - if either argument is null.
UnrecognizedProfileTableNameException - if a profile table with the specified name does not exist.
UnrecognizedProfileNameException - if a profile with the specified name does not exist in the profile table.
ManagementException - if the profile could not be removed due to a system-level failure.

getProfile

public javax.management.ObjectName getProfile(java.lang.String profileTableName,
                                              java.lang.String profileName)
                                       throws java.lang.NullPointerException,
                                              UnrecognizedProfileTableNameException,
                                              UnrecognizedProfileNameException,
                                              ManagementException
Get the JMX Object Name of a profile.
Parameters:
profileTableName - the name of the profile table to obtain the profile from.
profileName - the name of the profile.
Returns:
the Object Name of the profile.
Throws:
java.lang.NullPointerException - if either argument is null.
UnrecognizedProfileTableNameException - if a profile table with the specified name does not exist.
UnrecognizedProfileNameException - if a profile with the specified name does not exist in the profile table.
ManagementException - if the profile could not be obtained due to a system-level failure.

getProfileTables

public java.util.Collection getProfileTables()
                                      throws ManagementException
Get a collection of java.lang.String objects that identify the names of all the profile tables that have been created in the SLEE.
Returns:
a collection of java.lang.String objects identifying the names of all the profile tables that have been created in the SLEE.
Throws:
ManagementException - if the MBean object could not be obtained due to a system-level failure.

getProfiles

public java.util.Collection getProfiles(java.lang.String profileTableName)
                                 throws java.lang.NullPointerException,
                                        UnrecognizedProfileTableNameException,
                                        ManagementException
Get a collection of ProfileID objects that identify all the profiles contained in a specified profile table.

Note: A profile identifier for the profile table's default profile will not be included in the collection returned by this method as the default profile has no such identifier.

Parameters:
profileTableName - the name of the profile table.
Returns:
a collection of ProfileID objects identifying the profiles contained in the specified profile table.
Throws:
java.lang.NullPointerException - if profileTableName is null.
UnrecognizedProfileTableNameException - if a profile table with the specified name does not exist.
ManagementException - if the MBean object could not be obtained due to a system-level failure.

getProfilesByIndexedAttribute

public java.util.Collection getProfilesByIndexedAttribute(java.lang.String profileTableName,
                                                          java.lang.String attributeName,
                                                          java.lang.Object attributeValue)
                                                   throws java.lang.NullPointerException,
                                                          UnrecognizedProfileTableNameException,
                                                          UnrecognizedAttributeException,
                                                          AttributeNotIndexedException,
                                                          AttributeTypeMismatchException,
                                                          ManagementException
Get a collection of ProfileID objects that identify the profiles contained in a specified profile table where a specified profile attribute is set to a specified value.

Note: The profile table's default profile is not considered when determining matching profiles as it has no profile identifier that can be included in the collection returned by this method.

Parameters:
profileTableName - the name of the profile table.
attributeName - the name of the profile's attribute to check.
attributeValue - the value to compare the attribute with.
Returns:
a collection of ProfileID objects identifying the profiles contained in the specified profile table, where the specified attribute of each profile equals the specified value.
Throws:
java.lang.NullPointerException - if any argument is null.
UnrecognizedProfileTableNameException - if a profile table with the specified name does not exist.
UnrecognizedAttributeException - if an attribute with the specified name is not defined in the profile specification for the specified profile table.
AttributeNotIndexedException - if the specified attribute is not indexed in the profile specification for the specified profile table.
AttributeTypeMismatchException - if the type of the supplied attribute value does not match the type of the specified indexed attribute.
ManagementException - if the MBean object could not be obtained due to a system-level failure.