public interface ProfileProvisioningService
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
ProfileSpecification s. |
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
ProfileTable s. |
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. |
boolean profileTableExists(String profileTable) throws ServiceException
profileTable
- name of the profile table to checktrue
if the specified profile table exists, false
otherwiseServiceException
- if any unexpected error occursList<String> listProfiles(String profileTable) throws UnrecognizedProfileTableNameException, ServiceException
profileTable
- name of the profile table to list profiles forUnrecognizedProfileTableNameException
- if no profile table with
the specified table name can be foundServiceException
- if any unexpected error occursList<com.opencloud.rem.common.profile.ProfileDetail> getProfiles(String profileTable, boolean sortAscending, int start, int maxEntries) throws UnrecognizedProfileTableNameException, ServiceException
profileTable
- name of the profile table to retrieve profiles fromsortAscending
- true
to sort profiles by name in ascending
order, false
to sort in descending orderstart
- the index (starting at 0) of the first profile to returnmaxEntries
- the maximum number of profiles to returnstart
index and including no more than maxEntries
entriesUnrecognizedProfileTableNameException
- if no profile table with
the specified table name can be foundServiceException
- if any unexpected error occurscom.opencloud.rem.common.form.Form getProfileTableFormSchema(String profileTable) throws UnrecognizedProfileTableNameException, ServiceException
Form
schema for the specified profile table.profileTable
- the name of the profile table to build the form
schema forForm
representing the schema for the specified profile
tableUnrecognizedProfileTableNameException
- if no profile table with
the specified table name can be foundServiceException
- if any unexpected error occurscom.opencloud.rem.common.profile.ProfileDetail getProfile(String profileTable, String profileName) throws UnrecognizedProfileTableNameException, UnrecognizedProfileNameException, ServiceException
profileTable
- name of the profile table to retrieve profile fromprofileName
- name of the profile to retrieveProfileDetail
object containing the name and attributes
of the requested profileUnrecognizedProfileTableNameException
- if no profile table with
the specified table name can be foundUnrecognizedProfileNameException
- if no profile with the specified
name can be found in the specified tableServiceException
- if any unexpected error occursvoid removeProfileTable(String profileTable) throws UnrecognizedProfileTableNameException, ServiceException
profileTable
- the name of the profile table to be removedUnrecognizedProfileTableNameException
- if no profile table with
the specified table name can be foundServiceException
- if any unexpected error occursvoid createProfileTable(com.opencloud.rem.common.profile.ProfileSpecification profileSpecification, String newProfileTableName) throws ProfileTableAlreadyExistsException, UnrecognizedProfileSpecificationException, ServiceException
ProfileSpecification
.profileSpecification
- newProfileTableName
- ProfileTableAlreadyExistsException
UnrecognizedProfileSpecificationException
ServiceException
com.opencloud.rem.common.profile.ProfileDetail createProfile(String profileTable, com.opencloud.rem.common.profile.ProfileDetail newProfile) throws ProfileVerificationException, UnrecognizedProfileTableNameException, ProfileAlreadyExistsException, ServiceException
profileTable
- the name of the profile table to create the profile
innewProfile
- the ProfileDetail
object representing the
profile to createProfileDetail
object representing the created profileProfileVerificationException
- if the profile failed to pass
verificationUnrecognizedProfileTableNameException
- if no profile table with
the specified table name can be foundProfileAlreadyExistsException
- if a profile with the same name as
specified in the ProfileDetail
object already exists
in the given tableServiceException
- if any unexpected error occurscom.opencloud.rem.common.profile.ProfileDetail updateProfile(String profileTable, com.opencloud.rem.common.profile.ProfileDetail updatedProfile) throws ProfileVerificationException, UnrecognizedProfileTableNameException, UnrecognizedProfileNameException, ServiceException
ProfileDetail
object.profileTable
- the name of the profile table to update the profile
inupdatedProfile
- the ProfileDetail
object containing the
profile name and attributes to updateProfileDetail
object representing the updated profileProfileVerificationException
- if the profile failed to pass
verificationUnrecognizedProfileTableNameException
- if no profile table with
the specified table name can be foundUnrecognizedProfileNameException
- if no profile with the specified
name can be found in the specified tableServiceException
- if any unexpected error occursList<com.opencloud.rem.common.profile.ProfileSpecification> getProfileSpecifications() throws ServiceException
ProfileSpecification
s.ProfileSpecification
sServiceException
- if any unexpected error occursList<com.opencloud.rem.common.profile.ProfileTable> getProfileTables() throws ServiceException
ProfileTable
s.ProfileTable
sServiceException
- if any unexpected error occursint getProfileCount(String profileTable) throws UnrecognizedProfileTableNameException, ServiceException
profileTable
- the name of the profile table to get the total
profile count forUnrecognizedProfileTableNameException
- if no profile table with
the specified table name can be foundServiceException
- if any unexpected error occurscom.opencloud.rem.common.profile.ProfileSpecification getProfileSpecification(String profileTable) throws UnrecognizedProfileTableNameException, ServiceException
ProfileSpecification
of the specified profile table.profileTable
- the name of the profile table to get the profile
specification forProfileSpecification
of the specified profile tableUnrecognizedProfileTableNameException
- if no profile table with
the specified table name can be foundServiceException
- if any unexpected error occursvoid removeProfile(String profileTable, String profileName) throws UnrecognizedProfileTableNameException, UnrecognizedProfileNameException, ServiceException
profileTable
- name of the profile table to remove the profile fromprofileName
- name of the profile to removeUnrecognizedProfileTableNameException
- if no profile table with
the specified table name can be foundUnrecognizedProfileNameException
- if no profile with the specified
name can be found in the specified tableServiceException
- if any unexpected error occurs