Skip navigation links

oracle.security.jps.mas.mgmt.jmx.policy
Interface JpsApplicationPolicyStoreMXBean

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.description",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@ImmutableInfo(value="true")
@Since(value="11.1.1.0.0")
@Visibility(value=Advanced)
@SystemMBean
public interface JpsApplicationPolicyStoreMXBean

This interface exposes methods that can be used via MBeans to perform operations on the Policy Store.

Field Summary

static java.lang.String

RBN Data member to hold the ResourceBundle that will be used.

Method Summary

void	addMembersToApplicationRole(java.lang.String strAppId, PortableApplicationRole appRole, PortableRoleMember[] arrMembers) Function to Add Members to a specfic Application Role.
void	createApplicationPolicy(java.lang.String appId) Creates an application policy given the application name - appid.
PortableApplicationRole	createApplicationRole(java.lang.String strAppId, java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.String guid) Function to create an application role.
void	createResourceType(java.lang.String appStripe, java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.String provider, java.lang.String matcher, java.lang.String[] allowedActions, java.lang.String delimiter) Create a ResourceType in a given application stripe
void	deleteApplicationPolicy(java.lang.String appId) Delete an application policy given the application name - appid.
void	deleteResourceType(java.lang.String appStripe, java.lang.String resourceTypeName) Delete a ResourceType from a given application stripe
PortableApplicationRole[]	getAllApplicationRoles(java.lang.String strAppId) Function to retrieve the different Application Roles associated with an application.
PortableJavaPolicy	getApplicationPolicy(java.lang.String appId) Return the Policy for the application.
PortableApplicationRole	getApplicationRole(java.lang.String strAppId, java.lang.String name) Function to retrieve an already created application role.
java.lang.String[]	getConfiguredApplications() Function to retrieve the Names of Applications whose policies that are present in the policy store.
PortableApplicationRole[]	getGrantedApplicationRoles(java.lang.String strAppId, PortableRoleMember roleMember) Function to return the Application Roles which have been granted to the principal.
PortableRoleMember[]	getMembersForApplicationRole(java.lang.String strAppId, PortableApplicationRole appRole) Function to retrieve the different Members for a specific application role.
PortablePermission[]	getPermissions(java.lang.String appId, PortablePrincipal principal) Returns the permissions granted to the passed in principal.
PortableResourceType	getResourceType(java.lang.String appStripe, java.lang.String resourceTypeName) Get a ResourceType from a given application stripe
void	grantToApplicationPolicy(java.lang.String strAppId, PortableGrant[] arrPortableGrants) Function to add grants to a specific Application Policy.
java.lang.Boolean[]	hasPermission(java.lang.String appId, PortablePermission[] arrPerms) Function to check which Permission(s) the user has for an application
java.lang.Boolean[]	hasPermission(java.lang.String appId, javax.security.auth.Subject user, PortablePermission[] arrPerms) Function to check which Permission(s) the user has for an application
void	removeApplicationRole(java.lang.String strAppId, java.lang.String name) Function to delete an application role.
void	removeMembersFromApplicationRole(java.lang.String strAppId, PortableApplicationRole appRole, PortableRoleMember[] arrMembers) Function to remove Members from a specfic Application Role.
void	revokeFromApplicationPolicy(java.lang.String strAppId, PortableGrant[] arrPortableGrants) Function to revoke grants from a specific Application Policy.
void	updateApplicationRole(java.lang.String strAppId, java.lang.String appRoleName, java.lang.String newDescription, java.lang.String newDisplayName) Function to update description and display name for an existing application role.

Field Detail

RBN

static final java.lang.String RBN

Data member to hold the ResourceBundle that will be used.

See Also:

Constant Field Values

Method Detail

getConfiguredApplications

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.getConfiguredApplications",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.lang.String[] getConfiguredApplications()
                                             throws oracle.as.jmx.framework.exceptions.ManagementException,
                                                    java.io.IOException

Function to retrieve the Names of Applications whose policies that are present in the policy store.

Returns:

String[] which contains the ids of the applications configured within the store

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - Exception that will encapulate the reason for the failure

java.io.IOException - Exception if it was not possible to communicate with the server object

getApplicationPolicy

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.getApplicationPolicy",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableJavaPolicy getApplicationPolicy(java.lang.String appId)
                                        throws oracle.as.jmx.framework.exceptions.ManagementException,
                                               java.io.IOException

Return the Policy for the application.

Parameters:

appId - Application Id who's policy is to be retrieved

Returns:

PortableJavaPolicy which contains the policy related to the application

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - Exception that will encapulate the reason for the failure

java.io.IOException - Exception if it was not possible to communicate with the server object

grantToApplicationPolicy

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.grantToApplicationPolicy",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void grantToApplicationPolicy(java.lang.String strAppId,
                                                 PortableGrant[] arrPortableGrants)
                              throws oracle.as.jmx.framework.exceptions.ManagementException,
                                     java.io.IOException

Function to add grants to a specific Application Policy.

Parameters:

strAppId - Application Id where the grant has to be performed

arrPortableGrants - The array of PortableGrant which contains information about the Grants

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - Exception that will encapulate the reason for the failure

java.io.IOException - Exception if it was not possible to communicate with the server object

revokeFromApplicationPolicy

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.revokeFromApplicationPolicy",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void revokeFromApplicationPolicy(java.lang.String strAppId,
                                                    PortableGrant[] arrPortableGrants)
                                 throws oracle.as.jmx.framework.exceptions.ManagementException,
                                        java.io.IOException

Function to revoke grants from a specific Application Policy.

Parameters:

strAppId - Application Id where the revoke has to be performed

arrPortableGrants - The array of PortableGrant which contains information about the Grants

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - Exception that will encapulate the reason for the failure

java.io.IOException - Exception if it was not possible to communicate with the server object

createApplicationRole

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.createAppRole",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
PortableApplicationRole createApplicationRole(java.lang.String strAppId,
                                                                 java.lang.String name,
                                                                 java.lang.String displayName,
                                                                 java.lang.String description,
                                                                 java.lang.String guid)
                                              throws oracle.as.jmx.framework.exceptions.ManagementException,
                                                     java.io.IOException

Function to create an application role.

Parameters:

strAppId - Application Id where the role is to be created

name - Name to be used for the Application Role

displayName - Display Name for the Application Role

description - Description for the Aplication Role

guid - String representing the Guid

Returns:

PortableApplicationRole created Application Role

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - Exception that will encapulate the reason for the failure

java.io.IOException - Exception if it was not possible to communicate with the server object

updateApplicationRole

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.createAppRole",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void updateApplicationRole(java.lang.String strAppId,
                                              java.lang.String appRoleName,
                                              java.lang.String newDescription,
                                              java.lang.String newDisplayName)
                           throws oracle.as.jmx.framework.exceptions.ManagementException

Function to update description and display name for an existing application role.

Parameters:

strAppId - Application Id where the role is created

appRoleName - Name of the Application Role

newDisplayName - The new Display Name for the Application Role

newDescription - The new Description for the Application Role

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - Exception that will encanpsulate the reason for the failure

getApplicationRole

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.getAppRole",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableApplicationRole getApplicationRole(java.lang.String strAppId,
                                                              java.lang.String name)
                                           throws oracle.as.jmx.framework.exceptions.ManagementException,
                                                  java.io.IOException

Function to retrieve an already created application role.

Parameters:

strAppId - Application Id where the role has been created

name - Name of the Application Role

Returns:

PortableApplicationRole which represents the Application Role

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - Exception that will encapulate the reason for the failure

java.io.IOException - Exception if it was not possible to communicate with the server object

removeApplicationRole

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.removeAppRole",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void removeApplicationRole(java.lang.String strAppId,
                                              java.lang.String name)
                           throws oracle.as.jmx.framework.exceptions.ManagementException,
                                  java.io.IOException

Function to delete an application role.

Parameters:

strAppId - Application Id where the role has to be deleted

name - The Name of the Application Role that has to be removed

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - Exception that will encapulate the reason for the failure

java.io.IOException - Exception if it was not possible to communicate with the server object

getAllApplicationRoles

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.getApplicationRoles",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableApplicationRole[] getAllApplicationRoles(java.lang.String strAppId)
                                                 throws oracle.as.jmx.framework.exceptions.ManagementException,
                                                        java.io.IOException

Function to retrieve the different Application Roles associated with an application.

Parameters:

strAppId - Application Id

Returns:

Array of Application Roles

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - Exception that will encapulate the reason for the failure

java.io.IOException - Exception if it was not possible to communicate with the server object

getMembersForApplicationRole

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.getMembersForApplicationRole",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableRoleMember[] getMembersForApplicationRole(java.lang.String strAppId,
                                                                     PortableApplicationRole appRole)
                                                  throws oracle.as.jmx.framework.exceptions.ManagementException,
                                                         java.io.IOException

Function to retrieve the different Members for a specific application role.

Parameters:

strAppId - Application Id

appRole - Application Role for which we want to get the members

Returns:

Array of Role Members

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - Exception that will encapulate the reason for the failure

java.io.IOException - Exception if it was not possible to communicate with the server object

addMembersToApplicationRole

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.addMembersToApplicationRole",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void addMembersToApplicationRole(java.lang.String strAppId,
                                                    PortableApplicationRole appRole,
                                                    PortableRoleMember[] arrMembers)
                                 throws oracle.as.jmx.framework.exceptions.ManagementException,
                                        java.io.IOException

Function to Add Members to a specfic Application Role.

Parameters:

strAppId - Application id

appRole - Application Role for which we want to add members

arrMembers - The array which contains the memebers that should be added to the role

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - Exception that will encapulate the reason for the failure

java.io.IOException - Exception if it was not possible to communicate with the server object

removeMembersFromApplicationRole

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.removeMembersFromApplicationRole",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void removeMembersFromApplicationRole(java.lang.String strAppId,
                                                         PortableApplicationRole appRole,
                                                         PortableRoleMember[] arrMembers)
                                      throws oracle.as.jmx.framework.exceptions.ManagementException,
                                             java.io.IOException

Function to remove Members from a specfic Application Role.

Parameters:

strAppId - Application id

appRole - Application Role for which we want to remove members

arrMembers - The array which contains the memebers that should be removed from the role

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - Exception that will encapulate the reason for the failure

java.io.IOException - Exception if it was not possible to communicate with the server object

getGrantedApplicationRoles

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.getGrantedApplicationRoles",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableApplicationRole[] getGrantedApplicationRoles(java.lang.String strAppId,
                                                                        PortableRoleMember roleMember)
                                                     throws oracle.as.jmx.framework.exceptions.ManagementException,
                                                            java.io.IOException

Function to return the Application Roles which have been granted to the principal.

Parameters:

strAppId - Application Id

roleMember - Member for which we are tryin to get the Application Role

Returns:

Array of Application Roles

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - Exception that will encapulate the reason for the failure

java.io.IOException - Exception if it was not possible to communicate with the server object

hasPermission

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.hasPermission",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.lang.Boolean[] hasPermission(java.lang.String appId,
                                                     javax.security.auth.Subject user,
                                                     PortablePermission[] arrPerms)
                                  throws oracle.as.jmx.framework.exceptions.ManagementException,
                                         java.io.IOException

Function to check which Permission(s) the user has for an application

Parameters:

appId - The Application Id

user - The User for which we have to do the check

arrPerms - Array of Permissions

Returns:

Array of Booleans

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - Exception that will encapulate the reason for the failure

java.io.IOException - Exception if it was not possible to communicate with the server object

hasPermission

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.hasPermission",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.lang.Boolean[] hasPermission(java.lang.String appId,
                                                     PortablePermission[] arrPerms)
                                  throws oracle.as.jmx.framework.exceptions.ManagementException,
                                         java.io.IOException

Function to check which Permission(s) the user has for an application

Parameters:

appId - The Application Id

arrPerms - Array of Permissions

Returns:

Array of Booleans

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - Exception that will encapulate the reason for the failure

java.io.IOException - Exception if it was not possible to communicate with the server object

getPermissions

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.getPermissions",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortablePermission[] getPermissions(java.lang.String appId,
                                                       PortablePrincipal principal)
                                    throws oracle.as.jmx.framework.exceptions.ManagementException,
                                           java.io.IOException

Returns the permissions granted to the passed in principal.

Parameters:

appId - The Application Id

principal - Principal

Returns:

Permissions granted.

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - Exception that will encapulate the reason for the failure

java.io.IOException - Exception if it was not possible to communicate with the server object

createApplicationPolicy

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.createApplicationPolicy",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void createApplicationPolicy(java.lang.String appId)
                             throws oracle.as.jmx.framework.exceptions.ManagementException,
                                    java.io.IOException

Creates an application policy given the application name - appid.

If neccessary, create an application policy and return to caller. Based on the algorithm in JpsAuth this checks for PolicyStoreAccessPermission("context=APPLICATION,name=Applicaiton's stripe Id" , "createApplicationPolicy"). This may result in an AccessControlException or SecurityException

Parameters:

appId -

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

java.io.IOException

deleteApplicationPolicy

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.deleteApplicationPolicy",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void deleteApplicationPolicy(java.lang.String appId)
                             throws oracle.as.jmx.framework.exceptions.ManagementException,
                                    java.io.IOException

Delete an application policy given the application name - appid.

Based on the algorithm in JpsAuth this checks for PolicyStoreAccessPermission("context=APPLICATION,name=Applicaiton's stripe Id" , "deleteApplicationPolicy"). This may result in an AccessControlException or SecurityException

Parameters:

appId -

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

java.io.IOException

createResourceType

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.createResourceType",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void createResourceType(java.lang.String appStripe,
                                           java.lang.String name,
                                           java.lang.String displayName,
                                           java.lang.String description,
                                           java.lang.String provider,
                                           java.lang.String matcher,
                                           java.lang.String[] allowedActions,
                                           java.lang.String delimiter)
                        throws javax.management.MBeanException

Create a ResourceType in a given application stripe

Parameters:

appStripe - The application stripe in which this resourcetype has to be created

name - The name of the resourcetype

displayName - The display name of this resource type

description - Description for this resourcetype

provider - Provider for this reesourcetype. Can be null

matcher - Matcher class for this resourcetype

allowedActions - Comma Separated list of actions for this resourcetype. Can be null

delimiter - delimter for the actions of this resourcetype. If null , defaults to ","

Throws:

{@link - MBeanException}

javax.management.MBeanException

getResourceType

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.getResourceType",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableResourceType getResourceType(java.lang.String appStripe,
                                                        java.lang.String resourceTypeName)
                                     throws javax.management.MBeanException

Get a ResourceType from a given application stripe

Parameters:

appStripe - The application stripe in which this resourcetype has to be created

name - The name of the resourcetype

Throws:

{@link - MBeanException}

javax.management.MBeanException

deleteResourceType

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.deleteResourceType",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void deleteResourceType(java.lang.String appStripe,
                                           java.lang.String resourceTypeName)
                        throws javax.management.MBeanException

Delete a ResourceType from a given application stripe

Parameters:

appStripe - The application stripe in which this resourcetype has to be created

name - The name of the resourcetype

Throws:

{@link - MBeanException}

javax.management.MBeanException

Skip navigation links