com.opencloud.rem.service

Interface ProfileProvisioningService

public interface ProfileProvisioningService

Service for managing SLEE profile tables and profiles.

Method Summary

Methods

Modifier and Type	Method and Description
com.opencloud.rem.common.profile.ProfileDetail	createProfile(String profileTable, com.opencloud.rem.common.profile.ProfileDetail newProfile) Creates the given profile in the specified table.
void	createProfileTable(com.opencloud.rem.common.profile.ProfileSpecification profileSpecification, String newProfileTableName) Creates the specified profile table using the given ProfileSpecification.
com.opencloud.rem.common.profile.ProfileDetail	getProfile(String profileTable, String profileName) Retrieves a single profile and its attributes.
int	getProfileCount(String profileTable) Returns the total number of profiles in the specified profile table.
List<com.opencloud.rem.common.profile.ProfileDetail>	getProfiles(String profileTable, boolean sortAscending, int start, int maxEntries) Retrieves a paged listing of profiles, with their attributes, from a profile table.
com.opencloud.rem.common.profile.ProfileSpecification	getProfileSpecification(String profileTable) Returns the ProfileSpecification of the specified profile table.
List<com.opencloud.rem.common.profile.ProfileSpecification>	getProfileSpecifications() Retrieves a list of all available ProfileSpecifications.
com.opencloud.rem.common.form.Form	getProfileTableFormSchema(String profileTable) Builds a Form schema for the specified profile table.
List<com.opencloud.rem.common.profile.ProfileTable>	getProfileTables() Retrieves a list of all ProfileTables.
List<String>	listProfiles(String profileTable) Retrieves a listing of profile names from profile table.
boolean	profileTableExists(String profileTable) Checks if a profile table exists.
void	removeProfile(String profileTable, String profileName) Remove a profile from a profile table.
void	removeProfileTable(String profileTable) Removes the specified profile table.
com.opencloud.rem.common.profile.ProfileDetail	updateProfile(String profileTable, com.opencloud.rem.common.profile.ProfileDetail updatedProfile) Applies updates to a profile's attribute values provided in the specified ProfileDetail object.

Method Detail

profileTableExists

boolean profileTableExists(String profileTable)
                           throws ServiceException

Checks if a profile table exists.

Parameters:

profileTable - name of the profile table to check

Returns:

true if the specified profile table exists, false otherwise

Throws:

ServiceException - if any unexpected error occurs

listProfiles

List<String> listProfiles(String profileTable)
                          throws UnrecognizedProfileTableNameException,
                                 ServiceException

Retrieves a listing of profile names from profile table.

Parameters:

profileTable - name of the profile table to list profiles for

Returns:

a sorted list of profile names

Throws:

UnrecognizedProfileTableNameException - if no profile table with the specified table name can be found

ServiceException - if any unexpected error occurs

getProfiles

List<com.opencloud.rem.common.profile.ProfileDetail> getProfiles(String profileTable,
                                                               boolean sortAscending,
                                                               int start,
                                                               int maxEntries)
                                                                 throws UnrecognizedProfileTableNameException,
                                                                        ServiceException

Retrieves a paged listing of profiles, with their attributes, from a profile table.

Parameters:

profileTable - name of the profile table to retrieve profiles from

sortAscending - true to sort profiles by name in ascending order, false to sort in descending order

start - the index (starting at 0) of the first profile to return

maxEntries - the maximum number of profiles to return

Returns:

a sorted list of profiles, starting at the specified start index and including no more than maxEntries entries

Throws:

UnrecognizedProfileTableNameException - if no profile table with the specified table name can be found

ServiceException - if any unexpected error occurs

getProfileTableFormSchema

com.opencloud.rem.common.form.Form getProfileTableFormSchema(String profileTable)
                                                             throws UnrecognizedProfileTableNameException,
                                                                    ServiceException

Builds a Form schema for the specified profile table.

Parameters:

profileTable - the name of the profile table to build the form schema for

Returns:

a Form representing the schema for the specified profile table

Throws:

UnrecognizedProfileTableNameException - if no profile table with the specified table name can be found

ServiceException - if any unexpected error occurs

getProfile

com.opencloud.rem.common.profile.ProfileDetail getProfile(String profileTable,
                                                        String profileName)
                                                          throws UnrecognizedProfileTableNameException,
                                                                 UnrecognizedProfileNameException,
                                                                 ServiceException

Retrieves a single profile and its attributes.

Parameters:

profileTable - name of the profile table to retrieve profile from

profileName - name of the profile to retrieve

Returns:

a ProfileDetail object containing the name and attributes of the requested profile

Throws:

UnrecognizedProfileTableNameException - if no profile table with the specified table name can be found

UnrecognizedProfileNameException - if no profile with the specified name can be found in the specified table

ServiceException - if any unexpected error occurs

removeProfileTable

void removeProfileTable(String profileTable)
                        throws UnrecognizedProfileTableNameException,
                               ServiceException

Removes the specified profile table.

Parameters:

profileTable - the name of the profile table to be removed

Throws:

UnrecognizedProfileTableNameException - if no profile table with the specified table name can be found

ServiceException - if any unexpected error occurs

createProfileTable

void createProfileTable(com.opencloud.rem.common.profile.ProfileSpecification profileSpecification,
                      String newProfileTableName)
                        throws ProfileTableAlreadyExistsException,
                               UnrecognizedProfileSpecificationException,
                               ServiceException

Creates the specified profile table using the given ProfileSpecification.

Parameters:

profileSpecification -

newProfileTableName -

Throws:

ProfileTableAlreadyExistsException

UnrecognizedProfileSpecificationException

ServiceException

createProfile

com.opencloud.rem.common.profile.ProfileDetail createProfile(String profileTable,
                                                           com.opencloud.rem.common.profile.ProfileDetail newProfile)
                                                             throws ProfileVerificationException,
                                                                    UnrecognizedProfileTableNameException,
                                                                    ProfileAlreadyExistsException,
                                                                    ServiceException

Creates the given profile in the specified table.

Parameters:

profileTable - the name of the profile table to create the profile in

newProfile - the ProfileDetail object representing the profile to create

Returns:

the ProfileDetail object representing the created profile

Throws:

ProfileVerificationException - if the profile failed to pass verification

UnrecognizedProfileTableNameException - if no profile table with the specified table name can be found

ProfileAlreadyExistsException - if a profile with the same name as specified in the ProfileDetail object already exists in the given table

ServiceException - if any unexpected error occurs

updateProfile

com.opencloud.rem.common.profile.ProfileDetail updateProfile(String profileTable,
                                                           com.opencloud.rem.common.profile.ProfileDetail updatedProfile)
                                                             throws ProfileVerificationException,
                                                                    UnrecognizedProfileTableNameException,
                                                                    UnrecognizedProfileNameException,
                                                                    ServiceException

Applies updates to a profile's attribute values provided in the specified ProfileDetail object.

Parameters:

profileTable - the name of the profile table to update the profile in

updatedProfile - the ProfileDetail object containing the profile name and attributes to update

Returns:

the ProfileDetail object representing the updated profile

Throws:

ProfileVerificationException - if the profile failed to pass verification

UnrecognizedProfileTableNameException - if no profile table with the specified table name can be found

UnrecognizedProfileNameException - if no profile with the specified name can be found in the specified table

ServiceException - if any unexpected error occurs

getProfileSpecifications

List<com.opencloud.rem.common.profile.ProfileSpecification> getProfileSpecifications()
                                                                                     throws ServiceException

Retrieves a list of all available ProfileSpecifications.

Returns:

a sorted list of ProfileSpecifications

Throws:

ServiceException - if any unexpected error occurs

getProfileTables

List<com.opencloud.rem.common.profile.ProfileTable> getProfileTables()
                                                                     throws ServiceException

Retrieves a list of all ProfileTables.

Returns:

a sorted list of ProfileTables

Throws:

ServiceException - if any unexpected error occurs

getProfileCount

int getProfileCount(String profileTable)
                    throws UnrecognizedProfileTableNameException,
                           ServiceException

Returns the total number of profiles in the specified profile table.

Parameters:

profileTable - the name of the profile table to get the total profile count for

Returns:

the total number of profiles in the specified profile table

Throws:

UnrecognizedProfileTableNameException - if no profile table with the specified table name can be found

ServiceException - if any unexpected error occurs

getProfileSpecification

com.opencloud.rem.common.profile.ProfileSpecification getProfileSpecification(String profileTable)
                                                                              throws UnrecognizedProfileTableNameException,
                                                                                     ServiceException

Returns the ProfileSpecification of the specified profile table.

Parameters:

profileTable - the name of the profile table to get the profile specification for

Returns:

the ProfileSpecification of the specified profile table

Throws:

UnrecognizedProfileTableNameException - if no profile table with the specified table name can be found

ServiceException - if any unexpected error occurs

removeProfile

void removeProfile(String profileTable,
                 String profileName)
                   throws UnrecognizedProfileTableNameException,
                          UnrecognizedProfileNameException,
                          ServiceException

Remove a profile from a profile table.

Parameters:

profileTable - name of the profile table to remove the profile from

profileName - name of the profile to remove

Throws:

UnrecognizedProfileTableNameException - if no profile table with the specified table name can be found

UnrecognizedProfileNameException - if no profile with the specified name can be found in the specified table

ServiceException - if any unexpected error occurs