Package oracle.iam.provisioning.vo

Class Account

java.lang.Object
oracle.iam.provisioning.vo.Account
All Implemented Interfaces:
Serializable
public class Account extends Object implements Serializable
This class represents the account provisioned to user. This value object represents an entry in OIU table and meta-data related to ApplicationInstance. It contains AccountData that hold Parent and Child data associated to the account.
Since:
11.1.2.0.0
See Also:

  • Field Details

  • Constructor Details

    • Account

      public Account(ApplicationInstance appInstance, AccountData accountData)
      ' * This constructor can be used to form an Account value object while provisioning an account to user.
      Parameters:
      appInstance - - ApplicationInstance value object. The ApplicationInstance value object can be retrieved using one of the find method of ApplicationInstanceService
      accountData - - An AccountData value object. This value object contains ParentData and ChildData of an Account
      See Also:

    • Account

      public Account(String accountKey, String processInstanceKey, String userKey)
      This constructor will be used internally by provisioning engine when an account is already provisioned. AccountData and ApplicationInstance metadata will then be associated to this value object. If one wants to work with already provisioned account, refer to APIs provided in oracle.iam.provisioning.api.ProvisioningService to retrieve Account value object.
      Parameters:
      accountKey - - AccountID (OIU_KEY) of an account
      processInstanceKey - - ProcessInstance Key (ORC_KEY) of an account
      userKey - - User Key (USR_KEY) of an account.

    • Account

      public Account(String accountKey, String processInstanceKey, String userKey, RiskSummary riskSummary)
      This constructor will be used internally by provisioning engine when an account is already provisioned. AccountData and ApplicationInstance metadata will then be associated to this value object. If one wants to work with already provisioned account, refer to APIs provided in oracle.iam.provisioning.api.ProvisioningService to retrieve Account value object.
      Parameters:
      accountKey - - AccountID (OIU_KEY) of an account
      processInstanceKey - - ProcessInstance Key (ORC_KEY) of an account
      userKey - - User Key (USR_KEY) of an account.
      riskSummary - - Risk Summary of an account

  • Method Details

    • getValidFromDate

      public Date getValidFromDate()

    • setValidFromDate

      public void setValidFromDate(Date validFromDate)

    • getValidToDate

      public Date getValidToDate()

    • setValidToDate

      public void setValidToDate(Date validToDate)

    • isAccountPasswordEncrypted

      public boolean isAccountPasswordEncrypted()

    • setAccountPasswordEncrypted

      public void setAccountPasswordEncrypted(boolean accountPasswordEncrypted)

    • getRoleRequestKey

      public String getRoleRequestKey()

    • setRoleRequestKey

      public void setRoleRequestKey(String roleRequestKey)

    • getAccountID

      public String getAccountID()
      This method is used to get an account id (OIU_KEY).
      Returns:
      AccountID (OIU_KEY) of an account

    • setAccountInstanceID

      public void setAccountInstanceID(String accountKey)
      This method is used to set account id (OIU.KEY).
      Parameters:
      accountKey - AccountID (OIU_KEY) of an account.

    • getUserKey

      public String getUserKey()
      This method is used to get the key of the user to whom account is provisioned.
      Returns:
      User Key (USR_KEY) of an account.

    • setUserKey

      public void setUserKey(String userKey)
      This method is used to set the key of the user to whom account is provisioned.
      Parameters:
      userKey - User Key (USR_KEY) of an account.

    • getAppInstance

      public ApplicationInstance getAppInstance()
      This method is used to get the ApplicationInstance value object associated to an account.
      Returns:
      ApplicationInstance value object associated to an account

    • setAppInstance

      public void setAppInstance(ApplicationInstance appInstance)
      This method is used to set the ApplicationInstance value object associated to an account.
      Parameters:
      appInstance - ApplicationInstance value object of an account.

    • getProcessInstanceKey

      public String getProcessInstanceKey()
      This method is used to get the Process Instance Key (OIU_KEY) associated to an account.
      Returns:
      Process Instance Key (ORC_KEY) associated with an account.

    • setProcessInstanceKey

      public void setProcessInstanceKey(String processInstanceKey)
      This method is used to set the Process Instance Key (OIU_KEY) associated to an account.
      Parameters:
      processInstanceKey - Process Instance Key (ORC_KEY) of an account.

    • getPolicyKey

      public String getPolicyKey()
      This method is used to get the Policy Key (OIU.POL_KEY) associated to an account.
      Returns:
      Policy Key (POL_KEY) associated with an account if account is provisioned via Access Policy

    • setPolicyKey

      public void setPolicyKey(String policyKey)
      This method is used to set the Policy Key (OIU.POL_KEY) associated to an account.
      Parameters:
      policyKey - Access Policy Key (POL_KEY) of an account if account is getting provisioned via Access Policy.

    • getAccountDescriptiveField

      public String getAccountDescriptiveField()
      This method is used to get the unique name of the account.
      Returns:
      If the property AccountName = true is set in the process form associated with ApplicationInstance (via Resource Object, Process Definition), then the value returned is same as the value of the field on which this property is set. Otherwise, the value returned by this method is the value set in ORC_TOS_INSTANCE_KEY i.e Account Descriptive Field.

    • setAccountDescriptiveField

      public void setAccountDescriptiveField(String accountDescriptiveField)
      This method is used to set the unique name of the account.
      Parameters:
      accountDescriptiveField - If the property AccountName = true is set in the process form associated with ApplicationInstance (via Resource Object, Process Definition), then the value returned is same as the value of the field on which this property is set. Otherwise, the value returned by this method is the value set in ORC_TOS_INSTANCE_KEY i.e Account Descriptive Field.

    • getAccountData

      public AccountData getAccountData()
      This method is used to get the the AccountData value object, containing both parent and child data.
      Returns:
      The AccountData value object containg parent and child data.
      See Also:

    • setAccountData

      public void setAccountData(AccountData accountData)
      This method is used to set AccountData value object.
      Parameters:
      accountData - The AccountData value object

    • setAccountID

      public void setAccountID(String accountKey)
      This method is used to set AccountID of an Account
      Parameters:
      accountKey - This is an AccountID (OIU_KEY) of an account.

    • getAccountType

      public Account.ACCOUNT_TYPE getAccountType()
      This methid is used to set the account type of an account.
      Returns:
      This is type (OIU_TYPE) of an account.

    • setAccountType

      public void setAccountType(Account.ACCOUNT_TYPE accountType)
      This method is used to set AccountType. It can have one of the following values. - primary - The very first account of an application instance that is in provisioned status is marked as primary. Entitlments can be associated only to primary account during provisioning. If they need to be associated with other type of account (like other), then one needs to modify account. - secondery - additional type for future/customization. Not in use out-of-the-box. - admin - - additional type for future/customization. Not in use out-of-the-box. - other - If user already has a primary account, rest of the accounts will be defaulted to other - serviceaccount - If Account is marked as a service account. Note that service account can not be primary account. - unknown - If account is in provisioning status.
      Parameters:
      accountType -

    • getRequestKey

      public String getRequestKey()
      This method is used to get request key of (OIU.REQUEST_KEY) of an account. Request Key gets associated to account only at the time of Provision operation. Subsequent Enable, Disable, Revoke operations on the same account does not change the request key associated to an account.
      Returns:
      Request Key (REQUEST_KEY) associated to an account.

    • setRequestKey

      public void setRequestKey(String requestKey)
      This method is used to get request key of (OIU.REQUEST_KEY) of an account. Request Key gets associated to account only at the time of Provision operation. Subsequent Enable, Disable, Revoke operations on the same account does not change the request key associated to an account.
      Parameters:
      requestKey - Request Key to be associated to an account.

    • isServiceAccount

      public boolean isServiceAccount()
      Checks if account is a service account. Entitlements can not be associated to a service account.
      Returns:
      true if account is a service account, else returns false.

    • setServiceAccount

      public void setServiceAccount(boolean isServiceAccount)
      This method sets if an account is a service account.
      Parameters:
      isServiceAccount - Marks if account is a service account.

    • getAccountStatus

      public String getAccountStatus()
      This method returns the status of an account. Out of the box, the account status can be Provisioned, Provisioning, Enabled, Disabled, Revoked.
      Returns:
      account status (OIU_STATUS)

    • setAccountStatus

      public void setAccountStatus(String accountStatus)
      This method sets the status of an account
      Parameters:
      accountStatus - account status (OIU_STATUS)

    • getProvisionedOnDate

      public Date getProvisionedOnDate()
      This method gets the date on which an account is provisioned.
      Returns:
      The date on which an account is provisioned.

    • setProvisionedOnDate

      public void setProvisionedOnDate(Date provisionedOnDate)
      This method is used to set the date on which account is provisioned.
      Parameters:
      provisionedOnDate - The date on which an account is provisioned.

    • getPolicyBased

      public String getPolicyBased()
      Deprecated.
      Returns:

    • setPolicyBased

      public void setPolicyBased(String policyBased)
      Deprecated.

    • getInapplicableAccountAction

      public String getInapplicableAccountAction()
      Deprecated.
      Returns:

    • setInapplicableAccountAction

      public void setInapplicableAccountAction(String inapplicableAccountAction)
      Deprecated.

    • getProvisionedByMechanism

      public String getProvisionedByMechanism()
      Deprecated.
      Returns:

    • setProvisionedByMechanism

      public void setProvisionedByMechanism(String provisionedByMechanism)
      Deprecated.

    • getGrantInformation

      public Grant getGrantInformation()

    • getRiskSummary

      public RiskSummary getRiskSummary()

    • getNormalizedData

      public Map<String,List<Object>> getNormalizedData()

    • getProvisionedBy

      public String getProvisionedBy()

    • setProvisionedBy

      public void setProvisionedBy(String provisionedBy)

    • getEntitlementGrants

      public List<EntitlementInstance> getEntitlementGrants()

    • getEntitlementGrants

      public List<EntitlementInstance> getEntitlementGrants(String attributeName)

    • setEntitlementGrants

      public void setEntitlementGrants(List<EntitlementInstance> entitlementGrants)

    • addEntitlementGrants

      public void addEntitlementGrants(EntitlementInstance entitlementGrant)