Skip navigation links

Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server
11g Release 2 (11.1.2)

E27155-01 ESAPI


oracle.security.jps.service.policystore
Interface ApplicationPolicy

All Superinterfaces:
JavaPolicy, PolicyMgmt

public interface ApplicationPolicy
extends JavaPolicy, PolicyMgmt

The class represents an application in which entity objects and policies are created.

Since:
release specific (what release of product did this appear in)
Version:
$Header: jazn/jps/src/jps-api/oracle/security/jps/service/policystore/ApplicationPolicy.java /st_entsec_11.1.1.6.0_idm11.1.2.0.0/3 2012/02/16 20:21:36 jianz Exp $

Method Summary
 boolean changedSince(java.util.Date startTime)
          Check if the policy objects of this application have been changed since the specified time - startTime
 void createAppRole(java.lang.String appRoleName, java.lang.String displayName, java.lang.String desc, java.lang.String guid)
          Deprecated. replaced by AppRoleManager.createAppRole(String, String, String)
 void createAppRole(java.lang.String appRoleName, java.lang.String displayName, java.lang.String desc, java.lang.String guid, ExtendedProperty appRoleAttributes)
          Deprecated. replaced by AppRoleManager.createAppRole(String, String, String)
 AdminManager getAdminManager()
          Returns admin manager instance
 AppRoleManager getAppRoleManager()
          Returns application role manager instance
 long getCurrentPolicyVersion()
          Get current policy version
 java.lang.String getDescription()
          Get the description of this application.
 java.lang.String getDisplayName()
          Get the display name of this application.
 ExtensionManager getExtensionManager()
          Returns extension manager instance
 java.lang.String getName()
          Get the name of this application.
 PermissionSetManager getPermissionSetManager()
          Returns the PermissionSet Manager.
 PolicyDistributionManager getPolicyDistributionManager()
          Gets an instance of policy distribution manager
 PolicyDomainManager getPolicyDomainManager()
          Returns policy domain manager instance
 PolicyManager getPolicyManager()
          Returns the Policy Manager.
 ResourceManager getResourceManager()
          Returns Resource Manager
 ResourceTypeManager getResourceTypeManager()
          Returns resource type manager instance
 RoleCategoryManager getRoleCategoryManager()
          Returns the RoleCategory Manager.
 RolePolicyManager getRolePolicyManager()
          Returns the RolePolicy Manager.
 java.lang.String getUniqueName()
          Get the unique name of this application.
 java.lang.String getVersion()
          Returns the application version.
 void setDescription(java.lang.String description)
          Set the description of this application.
 void setDisplayName(java.lang.String displayName)
          Set the display name of this application.
 void setVersion(java.lang.String version)
          Set the application version in memory.

 

Methods inherited from interface oracle.security.jps.jaas.JavaPolicy
getPermissions, getPermissions, getPermissions, getPermissions, getPermissions, hasPermission, implies, refresh

 

Methods inherited from interface oracle.security.jps.service.policystore.PolicyMgmt
getGrantEntries, grant, grant, modifyGrant, revoke, revoke

 

Method Detail

createAppRole

void createAppRole(java.lang.String appRoleName,
                   java.lang.String displayName,
                   java.lang.String desc,
                   java.lang.String guid,
                   ExtendedProperty appRoleAttributes)
                   throws PolicyObjectAlreadyExistsException,
                          PolicyStoreException
Deprecated. replaced by AppRoleManager.createAppRole(String, String, String)
Creates the requested application role in the policy store with extended attributes.

Standard attributes supplied as parameters in this api ( DISPLAY_NAME, DESCRIPTION and GUID) cannot be part of the extended attributes.

The following code fragment illustrates how to construct the extended attributes:

     ExtendedProperty  ep = new ExtendedProperty();
     String attribute = ApplicationRoleAttributes.SCOPE.name();
     List < String > values = new ArrayList< String >();
     values.add( "user-defined-value");
     ep.setProperty(attribute, values);
 

Based on the algorithm in JpsAuth this checks for PolicyStoreAccessPermission("context=APPLICATION,name=Application's Stripe id", "createAppRole"). This may result in an AccessControlException or SecurityException

Parameters:
appRoleName - name of the application role
displayName - diplay name of the application role
desc - description of the application role
guid - guid of the application role
appRoleAttributes - - Extended attributes for the application role
Throws:
PolicyObjectAlreadyExistsException - if the role already exists.
PolicyStoreException - if the policy store provider reports an error while creating the role.
java.lang.IllegalArgumentException - if the standard attributes are part of
java.lang.NullPointerException - if the application name is empty. the extendedAttributes.
See Also:
for a list of valid extended attributes.

createAppRole

void createAppRole(java.lang.String appRoleName,
                   java.lang.String displayName,
                   java.lang.String desc,
                   java.lang.String guid)
                   throws PolicyObjectAlreadyExistsException,
                          PolicyStoreException
Deprecated. replaced by AppRoleManager.createAppRole(String, String, String)
Creates the requested application role in policy store.

Based on the algorithm in JpsAuth this checks for PolicyStoreAccessPermission("context=APPLICATION,name=Application's Stripe id", "createAppRole"). This may result in an AccessControlException or SecurityException

Parameters:
appRoleName - - name of the app role
displayName - - diplay name of the app role
desc - - description of the app role
guid - - guid of the app role
Throws:
PolicyObjectAlreadyExistsException - - if this application role already exists
PolicyStoreException - - if there is an error during this operation
java.lang.NullPointerException - if the application name is empty.

getName

java.lang.String getName()
Get the name of this application.
Returns:
application name

setVersion

void setVersion(java.lang.String version)
Set the application version in memory.

Supply null to remove the version.

To persist the changes in the store, use PolicyStore.modifyApplicationPolicy(ApplicationPolicy) To prevent multiple threads from updating the version concurrently in the store for the same application, the method PolicyStore.modifyApplicationPolicy(ApplicationPolicy) should be called called immediately after this method.


getVersion

java.lang.String getVersion()
Returns the application version. Will return null if the application version is not available
Returns:
the application version. Will return null if the application version is not available

getUniqueName

java.lang.String getUniqueName()
Get the unique name of this application.
Returns:
application unique name

getDisplayName

java.lang.String getDisplayName()
Get the display name of this application. Will throw PolicyStoreIncompatibleVersionException if PS3 schema is not supported.
Returns:
application display name

getDescription

java.lang.String getDescription()
Get the description of this application. Will throw PolicyStoreIncompatibleVersionException if PS3 schema is not supported.
Returns:
application description

setDisplayName

void setDisplayName(java.lang.String displayName)
Set the display name of this application. Will throw PolicyStoreIncompatibleVersionException if PS3 schema is not supported.

setDescription

void setDescription(java.lang.String description)
Set the description of this application. Will throw PolicyStoreIncompatibleVersionException if PS3 schema is not supported.

getCurrentPolicyVersion

long getCurrentPolicyVersion()
                             throws PolicyStoreException
Get current policy version
Returns:
current policy version
Throws:
PolicyStoreException

changedSince

boolean changedSince(java.util.Date startTime)
                     throws InvalidArgumentException,
                            PolicyStoreException
Check if the policy objects of this application have been changed since the specified time - startTime
Parameters:
startTime - the start time
Returns:
Throws:
InvalidArgumentException
PolicyStoreException

getResourceTypeManager

ResourceTypeManager getResourceTypeManager()
Returns resource type manager instance
Returns:
resourc type manager instance

getAppRoleManager

AppRoleManager getAppRoleManager()
Returns application role manager instance
Returns:
application role manager instance

getExtensionManager

ExtensionManager getExtensionManager()
Returns extension manager instance
Returns:
extension manager instance

getPolicyDomainManager

PolicyDomainManager getPolicyDomainManager()
Returns policy domain manager instance
Returns:
policy domain manager instance

getAdminManager

AdminManager getAdminManager()
Returns admin manager instance
Returns:
admin manager instance

getResourceManager

ResourceManager getResourceManager()
Returns Resource Manager

getPermissionSetManager

PermissionSetManager getPermissionSetManager()
Returns the PermissionSet Manager.

getPolicyManager

PolicyManager getPolicyManager()
Returns the Policy Manager.

getRoleCategoryManager

RoleCategoryManager getRoleCategoryManager()
Returns the RoleCategory Manager.

getRolePolicyManager

RolePolicyManager getRolePolicyManager()
Returns the RolePolicy Manager.

getPolicyDistributionManager

PolicyDistributionManager getPolicyDistributionManager()
Gets an instance of policy distribution manager
Returns:

Skip navigation links

Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server
11g Release 2 (11.1.2)

E27155-01 ESAPI


Copyright © 2011,2012, Oracle and/or its affiliates. All rights reserved.