public interface ProfileProvisioningMBean extends ProfileProvisioningMBean
ProfileProvisiningMBean
interface defines additional rhino management operations for creating, removing, and interacting with profiles and profile tables.OBJECT_NAME
Modifier and Type | Method and Description |
---|---|
void |
createProfiles(String profileTableName,
String[] profileNames,
AttributeList[] attributeList)
Creates new profile in a profile table.
|
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(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.
|
createProfile, createProfileTable, getProfileTables, removeProfile, removeProfileTable, renameProfileTable
void createProfiles(String profileTableName, String[] profileNames, AttributeList[] attributeList) throws NullPointerException, InvalidArgumentException, UnrecognizedProfileTableNameException, ProfileAlreadyExistsException, ProfileVerificationException, ManagementException
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.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
ProfileDataCollection exportProfiles(String profileTableName, String[] profileNames) throws NullPointerException, UnrecognizedProfileTableNameException, ManagementException
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.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.ProfileImportResult importProfiles(ProfileDataCollection profileData) throws NullPointerException, UnrecognizedProfileTableNameException, InvalidArgumentException, ProfileAlreadyExistsException, UnrecognizedProfileNameException, ProfileVerificationException, ManagementException
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.
profileData
- the profile data collection containing the exported profiles.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
ProfileImportResult importProfiles(ProfileDataCollection profileData, boolean verifyProfiles) throws NullPointerException, UnrecognizedProfileTableNameException, InvalidArgumentException, ProfileAlreadyExistsException, UnrecognizedProfileNameException, ProfileVerificationException, ManagementException
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.
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.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
ProfileSpecificationID getProfileSpecification(String profileTableName) throws NullPointerException, UnrecognizedProfileTableNameException, ManagementException
getProfileSpecification
in interface ProfileProvisioningMBean
NullPointerException
UnrecognizedProfileTableNameException
ManagementException
ObjectName getDefaultProfile(String profileTableName) throws NullPointerException, UnrecognizedProfileTableNameException, ManagementException
getDefaultProfile
in interface ProfileProvisioningMBean
NullPointerException
UnrecognizedProfileTableNameException
ManagementException
ObjectName getProfile(String profileTableName, String profileName) throws NullPointerException, UnrecognizedProfileTableNameException, UnrecognizedProfileNameException, ManagementException
getProfile
in interface ProfileProvisioningMBean
NullPointerException
UnrecognizedProfileTableNameException
UnrecognizedProfileNameException
ManagementException
Collection getProfileTables(ProfileSpecificationID id) throws NullPointerException, UnrecognizedProfileSpecificationException, ManagementException
getProfileTables
in interface ProfileProvisioningMBean
NullPointerException
UnrecognizedProfileSpecificationException
ManagementException
Collection getProfiles(String profileTableName) throws NullPointerException, UnrecognizedProfileTableNameException, ManagementException
getProfiles
in interface ProfileProvisioningMBean
NullPointerException
UnrecognizedProfileTableNameException
ManagementException
Collection getProfilesByIndexedAttribute(String profileTableName, String attributeName, Object attributeValue) throws NullPointerException, UnrecognizedProfileTableNameException, UnrecognizedAttributeException, AttributeNotIndexedException, AttributeTypeMismatchException, ManagementException
Collection getProfilesByAttribute(String profileTableName, String attributeName, Object attributeValue) throws NullPointerException, UnrecognizedProfileTableNameException, UnrecognizedAttributeException, InvalidArgumentException, AttributeTypeMismatchException, ManagementException
Collection getProfilesByStaticQuery(String profileTableName, String queryName, Object[] parameters) throws NullPointerException, UnrecognizedProfileTableNameException, UnrecognizedQueryNameException, InvalidArgumentException, AttributeTypeMismatchException, ManagementException
Collection getProfilesByDynamicQuery(String profileTableName, QueryExpression expr) throws NullPointerException, UnrecognizedProfileTableNameException, UnrecognizedAttributeException, AttributeTypeMismatchException, ManagementException
ObjectName getProfileTableUsageMBean(String profileTableName) throws NullPointerException, UnrecognizedProfileTableNameException, InvalidArgumentException, ManagementException
getProfileTableUsageMBean
in interface ProfileProvisioningMBean
NullPointerException
UnrecognizedProfileTableNameException
InvalidArgumentException
ManagementException