|
Oracle® Information Rights Management Server Java API Reference 11g Release 1 (11.1.1) E12907-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.irm.engine.core.account.AccountOperationsInstance
public final class AccountOperationsInstance
Operations for retrieving and querying user and group details.
This class provides static methods for a set of procedural style methods. The methods can be made to appear as global methods by using import static. e.g.
import static oracle.irm.engine.core.account.AccountOperationsInstance.*;
Method Summary | |
---|---|
static void |
checkForGroups(Collection<Account> accounts) Check that a set of accounts only contains users. |
static void |
copy(Account source, Account destination) Copy the information relating to an account to another account. |
static int |
dump(File folder) Dump all the account information into a folder. |
static Account |
getAccountByName(String name, Account.Type type) Get a user or group by name. |
static Account |
getAnonymousAccount() Get the anonymous account. |
static Account |
getAuthenticatedAccount() Get the authenticated account. |
static String |
getEmailAddress(Account account) Get an user's email address. |
static Collection<Account> |
listAccountDetails(Collection<Account> accounts) Retrieve the name and account type from one or more account UUID values. |
static Collection<Account> |
listAccounts(PageRange range) Lists accounts. |
static Collection<Account> |
listMembership(Account account) List account group membership. |
static UUID |
normalizeUuid(Account account) Normalize an account UUID or GUID into a standard UUID type. |
static void |
purge(Account account) Purge all information relating to an account. |
static int |
restore(File folder) Restore account information from a dump. |
static void |
transfer(Account source, Account destination) Transfer all information relating to an account to another account. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static Account getAnonymousAccount()
getAuthenticatedAccount
method will return the anonymous account. This method gives direct access to the anonymous account if it is unclear which account has been used as the anonymous account.public static Account getAuthenticatedAccount() throws AuthorizationDeniedException
AuthorizationDeniedException
- if the authenticated user does not exist in the user store. This exception indicates that the authenticated user no longer exists in the user store but the authentication session is still valid.public static String getEmailAddress(Account account) throws UnknownAccountException
account
- the account to query.UnknownAccountException
- the account does not exist.public static Account getAccountByName(String name, Account.Type type) throws UnknownAccountException
name
- the user or group name.type
- user or group.UnknownAccountException
- the account does not exist.public static void purge(Account account)
account
- the account to purge. This account does not have to exist in the external identity store.public static void transfer(Account source, Account destination) throws UnknownAccountException
Uuid
may change. In this scenario the account information relating to the account UUID in the IRM system will be orphaned. This method allows all the rights of the orphaned account to be transferred to another account. An example of the things that are transferred would be administration rights and role assignments.source
- the source account.destination
- the destination account.UnknownAccountException
- the destination account does not exist in the user store.public static void copy(Account source, Account destination) throws UnknownAccountException
source
- the source account.destination
- the destination account.UnknownAccountException
- the destination account does not exist in the user store.public static int dump(File folder) throws IOException
folder
- the output folder.IOException
- an error occurred writing out the account details.public static int restore(File folder) throws IOException
folder
- the input folder.IOException
- an error occurred reading the account details.public static Collection<Account> listAccounts(PageRange range)
range
- the range of accounts to return.public static Collection<Account> listMembership(Account account) throws UnknownAccountException
account
- the account to query.UnknownAccountException
- the account does not exist.public static Collection<Account> listAccountDetails(Collection<Account> accounts)
accounts
- the accounts. This parameter is optional, it is valid to pass null or an empty collection.public static void checkForGroups(Collection<Account> accounts) throws GroupNotSupportedException
accounts
- accounts to check. This parameter is optional, it is valid to pass null or an empty collection.GroupNotSupportedException
- one of the accounts is a group account.public static UUID normalizeUuid(Account account) throws IllegalArgumentException
Uuid
property may or may not be in the standard UUID format 00000000-0000-0000-0000-000000000000 depending on the type of user store used. This method attempts to convert from the various formats into a standard UUID type.account
- account.IllegalArgumentException
- the account Uuid
property is not in a supported UUID or GUID format.
|
Oracle® Information Rights Management Server Java API Reference 11g Release 1 (11.1.1) E12907-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |