|
Oracle Fusion Middleware MBeans Java API Reference for Oracle Platform Security Services 11g Release 1 (11.1.1) E14651-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@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 |
---|
static final java.lang.String RBN
Method Detail |
---|
@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
oracle.as.jmx.framework.exceptions.ManagementException
- Exception that will encapulate the reason for the failurejava.io.IOException
- Exception if it was not possible to communicate with the server object
@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
appId
- Application Id who's policy is to be retrievedoracle.as.jmx.framework.exceptions.ManagementException
- Exception that will encapulate the reason for the failurejava.io.IOException
- Exception if it was not possible to communicate with the server object
@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
strAppId
- Application Id where the grant has to be performedarrPortableGrants
- The array of PortableGrant which contains information about the Grantsoracle.as.jmx.framework.exceptions.ManagementException
- Exception that will encapulate the reason for the failurejava.io.IOException
- Exception if it was not possible to communicate with the server object
@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
strAppId
- Application Id where the revoke has to be performedarrPortableGrants
- The array of PortableGrant which contains information about the Grantsoracle.as.jmx.framework.exceptions.ManagementException
- Exception that will encapulate the reason for the failurejava.io.IOException
- Exception if it was not possible to communicate with the server object
@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
strAppId
- Application Id where the role is to be createdname
- Name to be used for the Application RoledisplayName
- Display Name for the Application Roledescription
- Description for the Aplication Roleguid
- String representing the Guidoracle.as.jmx.framework.exceptions.ManagementException
- Exception that will encapulate the reason for the failurejava.io.IOException
- Exception if it was not possible to communicate with the server object
@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
strAppId
- Application Id where the role is createdappRoleName
- Name of the Application RolenewDisplayName
- The new Display Name for the Application RolenewDescription
- The new Description for the Application Roleoracle.as.jmx.framework.exceptions.ManagementException
- Exception that will encanpsulate the reason for the failure
@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
strAppId
- Application Id where the role has been createdname
- Name of the Application Roleoracle.as.jmx.framework.exceptions.ManagementException
- Exception that will encapulate the reason for the failurejava.io.IOException
- Exception if it was not possible to communicate with the server object
@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
strAppId
- Application Id where the role has to be deletedname
- The Name of the Application Role that has to be removedoracle.as.jmx.framework.exceptions.ManagementException
- Exception that will encapulate the reason for the failurejava.io.IOException
- Exception if it was not possible to communicate with the server object
@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
strAppId
- Application Idoracle.as.jmx.framework.exceptions.ManagementException
- Exception that will encapulate the reason for the failurejava.io.IOException
- Exception if it was not possible to communicate with the server object
@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
strAppId
- Application IdappRole
- Application Role for which we want to get the membersoracle.as.jmx.framework.exceptions.ManagementException
- Exception that will encapulate the reason for the failurejava.io.IOException
- Exception if it was not possible to communicate with the server object
@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
strAppId
- Application idappRole
- Application Role for which we want to add membersarrMembers
- The array which contains the memebers that should be added to the roleoracle.as.jmx.framework.exceptions.ManagementException
- Exception that will encapulate the reason for the failurejava.io.IOException
- Exception if it was not possible to communicate with the server object
@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
strAppId
- Application idappRole
- Application Role for which we want to remove membersarrMembers
- The array which contains the memebers that should be removed from the roleoracle.as.jmx.framework.exceptions.ManagementException
- Exception that will encapulate the reason for the failurejava.io.IOException
- Exception if it was not possible to communicate with the server object
@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
strAppId
- Application IdroleMember
- Member for which we are tryin to get the Application Roleoracle.as.jmx.framework.exceptions.ManagementException
- Exception that will encapulate the reason for the failurejava.io.IOException
- Exception if it was not possible to communicate with the server object
@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
appId
- The Application Iduser
- The User for which we have to do the checkarrPerms
- Array of Permissionsoracle.as.jmx.framework.exceptions.ManagementException
- Exception that will encapulate the reason for the failurejava.io.IOException
- Exception if it was not possible to communicate with the server object
@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
appId
- The Application IdarrPerms
- Array of Permissionsoracle.as.jmx.framework.exceptions.ManagementException
- Exception that will encapulate the reason for the failurejava.io.IOException
- Exception if it was not possible to communicate with the server object
@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
appId
- The Application Idprincipal
- Principaloracle.as.jmx.framework.exceptions.ManagementException
- Exception that will encapulate the reason for the failurejava.io.IOException
- Exception if it was not possible to communicate with the server object
@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
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
appId
-oracle.as.jmx.framework.exceptions.ManagementException
java.io.IOException
@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
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
appId
-oracle.as.jmx.framework.exceptions.ManagementException
java.io.IOException
@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
appStripe
- The application stripe in which this resourcetype has to be createdname
- The name of the resourcetypedisplayName
- The display name of this resource typedescription
- Description for this resourcetypeprovider
- Provider for this reesourcetype. Can be null
matcher
- Matcher class for this resourcetypeallowedActions
- Comma Separated list of actions for this resourcetype. Can be null
delimiter
- delimter for the actions of this resourcetype. If null
, defaults to ","{@link
- MBeanException}javax.management.MBeanException
@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
appStripe
- The application stripe in which this resourcetype has to be createdname
- The name of the resourcetype{@link
- MBeanException}javax.management.MBeanException
@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
appStripe
- The application stripe in which this resourcetype has to be createdname
- The name of the resourcetype{@link
- MBeanException}javax.management.MBeanException
|
Oracle Fusion Middleware MBeans Java API Reference for Oracle Platform Security Services 11g Release 1 (11.1.1) E14651-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |