Package com.opencloud.rhino.management.profile

Interface ProfileProvisioningMBean

All Superinterfaces:

ProfileProvisioningMBean

public interface ProfileProvisioningMBean
extends ProfileProvisioningMBean

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

Field Summary

Fields inherited from interface javax.slee.management.ProfileProvisioningMBean

OBJECT_NAME

Method Summary

Modifier and Type	Method	Description
ObjectName	createProfile(String profileTableName, String newProfileName)
void	createProfiles(String profileTableName, String[] profileNames, AttributeList[] attributeList)	Creates new profile in a profile table.
void	createProfileTable(ProfileSpecificationID id, String newProfileTableName)
ProfileDataCollection	exportProfiles(String profileTableName, String[] profileNames)	Export a list of profiles from a profile table.
ObjectName	getDefaultProfile(String profileTableName)
ObjectName	getProfile(String profileTableName, String profileName)
Collection	getProfiles(String profileTableName)
Collection	getProfilesByAttribute(String profileTableName, String attributeName, Object attributeValue)
Collection	getProfilesByDynamicQuery(String profileTableName, QueryExpression expr)
Collection	getProfilesByIndexedAttribute(String profileTableName, String attributeName, Object attributeValue)
Collection	getProfilesByStaticQuery(String profileTableName, String queryName, Object[] parameters)
ProfileSpecificationID	getProfileSpecification(String profileTableName)
Collection	getProfileTables()
Collection	getProfileTables(ProfileSpecificationID id)
ObjectName	getProfileTableUsageMBean(String profileTableName)
ProfileImportResult	importProfiles(ProfileDataCollection profileData)	Import a collection of profile data.
ProfileImportResult	importProfiles(ProfileDataCollection profileData, boolean verifyProfiles)	Import a collection of profile data.
void	removeProfile(String profileTableName, String profileName)
void	removeProfileTable(String profileTableName)

Methods inherited from interface javax.slee.management.ProfileProvisioningMBean

renameProfileTable

Method Detail

createProfileTable

@SupportsUserTransactions
void createProfileTable(ProfileSpecificationID id,
                        String newProfileTableName)
                 throws NullPointerException,
                        UnrecognizedProfileSpecificationException,
                        InvalidArgumentException,
                        ProfileTableAlreadyExistsException,
                        ManagementException

Specified by:

createProfileTable in interface ProfileProvisioningMBean

Throws:

NullPointerException

UnrecognizedProfileSpecificationException

InvalidArgumentException

ProfileTableAlreadyExistsException

ManagementException

removeProfileTable

@SupportsUserTransactions
void removeProfileTable(String profileTableName)
                 throws NullPointerException,
                        UnrecognizedProfileTableNameException,
                        ManagementException

Specified by:

removeProfileTable in interface ProfileProvisioningMBean

Throws:

NullPointerException

UnrecognizedProfileTableNameException

ManagementException

createProfile

@SupportsUserTransactions
ObjectName createProfile(String profileTableName,
                         String newProfileName)
                  throws NullPointerException,
                         UnrecognizedProfileTableNameException,
                         InvalidArgumentException,
                         ProfileAlreadyExistsException,
                         ManagementException

Specified by:

createProfile in interface ProfileProvisioningMBean

Throws:

NullPointerException

UnrecognizedProfileTableNameException

InvalidArgumentException

ProfileAlreadyExistsException

ManagementException

createProfiles

@SupportsUserTransactions
void createProfiles(String profileTableName,
                    String[] profileNames,
                    AttributeList[] attributeList)
             throws NullPointerException,
                    InvalidArgumentException,
                    UnrecognizedProfileTableNameException,
                    ProfileAlreadyExistsException,
                    ProfileVerificationException,
                    ManagementException

Creates new profile in a profile table. The profile is added to the profile table using the unique profile name specified.

Parameters:

profileTableName - the name of the profile table to create the profile in.

profileNames - the names of the new profiles. These names must be unique within the scope of the profile table.

attributeList - collection of attribute values per profileName.

Throws:

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.

ProfileVerificationException

removeProfile

@SupportsUserTransactions
void removeProfile(String profileTableName,
                   String profileName)
            throws NullPointerException,
                   UnrecognizedProfileTableNameException,
                   UnrecognizedProfileNameException,
                   ManagementException

Specified by:

removeProfile in interface ProfileProvisioningMBean

Throws:

NullPointerException

UnrecognizedProfileTableNameException

UnrecognizedProfileNameException

ManagementException

exportProfiles

ProfileDataCollection exportProfiles(String profileTableName,
                                     String[] profileNames)
                              throws NullPointerException,
                                     UnrecognizedProfileTableNameException,
                                     ManagementException

Export a list of profiles from a profile table.

Parameters:

profileTableName - the name of the profile table to export from.

profileNames - an array listing the profile names to export. A null element in the array results in the profile table’s default profile being exported. Elements corresponding to unknown profile names are ignored.

Returns:

a profile data collection containing the exported profiles.

Throws:

NullPointerException - if either argument is null.

UnrecognizedProfileTableNameException - if a profile table with the specified name does not exist.

ManagementException - if the export cannot be completed successfully due to a system-level failure.

importProfiles

@SupportsUserTransactions
ProfileImportResult importProfiles(ProfileDataCollection profileData)
                            throws NullPointerException,
                                   UnrecognizedProfileTableNameException,
                                   InvalidArgumentException,
                                   ProfileAlreadyExistsException,
                                   UnrecognizedProfileNameException,
                                   ProfileVerificationException,
                                   ManagementException

Import a collection of profile data.

Note: it is permissible for the profile data collection to contain a profile with a null name. Such a profile indicates profile data for the profile table’s default profile. Default profile data is imported regardless of the value of the replace flag.

This method is equivalent to importProfiles(profileData, true), ie. the profileVerify() method will be invoked on each of the imported profiles.

Parameters:

profileData - the profile data collection containing the exported profiles.

Returns:

data class encapsulating the result of the import.

Throws:

NullPointerException - if profileData is null.

UnrecognizedProfileTableNameException - if a profile table with the name specified in the profile data does not exist.

InvalidArgumentException - if the schema of the profile table specified in the profile data does not match (or is not a subset of) the schema of the profile table in the SLEE, if the profile data contains non-serialised attribute data for attribute types with no codec available, or if an attribute value in a profile contains null values for primitive types.

ManagementException - if the import cannot be completed successfully due to a system-level failure.

ProfileAlreadyExistsException

UnrecognizedProfileNameException

ProfileVerificationException

importProfiles

@SupportsUserTransactions
ProfileImportResult importProfiles(ProfileDataCollection profileData,
                                   boolean verifyProfiles)
                            throws NullPointerException,
                                   UnrecognizedProfileTableNameException,
                                   InvalidArgumentException,
                                   ProfileAlreadyExistsException,
                                   UnrecognizedProfileNameException,
                                   ProfileVerificationException,
                                   ManagementException

Import a collection of profile data.

Note: it is permissible for the profile data collection to contain a profile with a null name. Such a profile indicates profile data for the profile table’s default profile. Default profile data is imported regardless of the value of the replace flag.

Parameters:

profileData - the profile data collection containing the exported profiles.

verifyProfiles - flag indicating if the profileVerify() method will be invoked on each of the imported profiles.

Returns:

data class encapsulating the result of the import.

Throws:

NullPointerException - if profileData is null.

UnrecognizedProfileTableNameException - if a profile table with the name specified in the profile data does not exist.

InvalidArgumentException - if the schema of the profile table specified in the profile data does not match (or is not a subset of) the schema of the profile table in the SLEE, if the profile data contains non-serialised attribute data for attribute types with no codec available, or if an attribute value in a profile contains null values for primitive types.

ManagementException - if the import cannot be completed successfully due to a system-level failure.

ProfileAlreadyExistsException

UnrecognizedProfileNameException

ProfileVerificationException

getProfileSpecification

ProfileSpecificationID getProfileSpecification(String profileTableName)
                                        throws NullPointerException,
                                               UnrecognizedProfileTableNameException,
                                               ManagementException

Specified by:

getProfileSpecification in interface ProfileProvisioningMBean

Throws:

NullPointerException

UnrecognizedProfileTableNameException

ManagementException

getDefaultProfile

@SupportsUserTransactions
ObjectName getDefaultProfile(String profileTableName)
                      throws NullPointerException,
                             UnrecognizedProfileTableNameException,
                             ManagementException

Specified by:

getDefaultProfile in interface ProfileProvisioningMBean

Throws:

NullPointerException

UnrecognizedProfileTableNameException

ManagementException

getProfile

@SupportsUserTransactions
ObjectName getProfile(String profileTableName,
                      String profileName)
               throws NullPointerException,
                      UnrecognizedProfileTableNameException,
                      UnrecognizedProfileNameException,
                      ManagementException

Specified by:

getProfile in interface ProfileProvisioningMBean

Throws:

NullPointerException

UnrecognizedProfileTableNameException

UnrecognizedProfileNameException

ManagementException

getProfileTables

@SupportsUserTransactions
Collection getProfileTables()
                     throws ManagementException

Specified by:

getProfileTables in interface ProfileProvisioningMBean

Throws:

ManagementException

getProfileTables

@SupportsUserTransactions
Collection getProfileTables(ProfileSpecificationID id)
                     throws NullPointerException,
                            UnrecognizedProfileSpecificationException,
                            ManagementException

Specified by:

getProfileTables in interface ProfileProvisioningMBean

Throws:

NullPointerException

UnrecognizedProfileSpecificationException

ManagementException

getProfiles

@SupportsUserTransactions
Collection getProfiles(String profileTableName)
                throws NullPointerException,
                       UnrecognizedProfileTableNameException,
                       ManagementException

Specified by:

getProfiles in interface ProfileProvisioningMBean

Throws:

NullPointerException

UnrecognizedProfileTableNameException

ManagementException

getProfilesByIndexedAttribute

@SupportsUserTransactions
Collection getProfilesByIndexedAttribute(String profileTableName,
                                         String attributeName,
                                         Object attributeValue)
                                  throws NullPointerException,
                                         UnrecognizedProfileTableNameException,
                                         UnrecognizedAttributeException,
                                         AttributeNotIndexedException,
                                         AttributeTypeMismatchException,
                                         ManagementException

Specified by:

getProfilesByIndexedAttribute in interface ProfileProvisioningMBean

Throws:

NullPointerException

UnrecognizedProfileTableNameException

UnrecognizedAttributeException

AttributeNotIndexedException

AttributeTypeMismatchException

ManagementException

getProfilesByAttribute

@SupportsUserTransactions
Collection getProfilesByAttribute(String profileTableName,
                                  String attributeName,
                                  Object attributeValue)
                           throws NullPointerException,
                                  UnrecognizedProfileTableNameException,
                                  UnrecognizedAttributeException,
                                  InvalidArgumentException,
                                  AttributeTypeMismatchException,
                                  ManagementException

Specified by:

getProfilesByAttribute in interface ProfileProvisioningMBean

Throws:

NullPointerException

UnrecognizedProfileTableNameException

UnrecognizedAttributeException

InvalidArgumentException

AttributeTypeMismatchException

ManagementException

getProfilesByStaticQuery

@SupportsUserTransactions
Collection getProfilesByStaticQuery(String profileTableName,
                                    String queryName,
                                    Object[] parameters)
                             throws NullPointerException,
                                    UnrecognizedProfileTableNameException,
                                    UnrecognizedQueryNameException,
                                    InvalidArgumentException,
                                    AttributeTypeMismatchException,
                                    ManagementException

Specified by:

getProfilesByStaticQuery in interface ProfileProvisioningMBean

Throws:

NullPointerException

UnrecognizedProfileTableNameException

UnrecognizedQueryNameException

InvalidArgumentException

AttributeTypeMismatchException

ManagementException

getProfilesByDynamicQuery

@SupportsUserTransactions
Collection getProfilesByDynamicQuery(String profileTableName,
                                     QueryExpression expr)
                              throws NullPointerException,
                                     UnrecognizedProfileTableNameException,
                                     UnrecognizedAttributeException,
                                     AttributeTypeMismatchException,
                                     ManagementException

Specified by:

getProfilesByDynamicQuery in interface ProfileProvisioningMBean

Throws:

NullPointerException

UnrecognizedProfileTableNameException

UnrecognizedAttributeException

AttributeTypeMismatchException

ManagementException

getProfileTableUsageMBean

ObjectName getProfileTableUsageMBean(String profileTableName)
                              throws NullPointerException,
                                     UnrecognizedProfileTableNameException,
                                     InvalidArgumentException,
                                     ManagementException

Specified by:

getProfileTableUsageMBean in interface ProfileProvisioningMBean

Throws:

NullPointerException

UnrecognizedProfileTableNameException

InvalidArgumentException

ManagementException