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

Interface JpsGlobalPolicyStoreMXBean

@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 JpsGlobalPolicyStoreMXBean

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RBN Data member to hold the Resource Bundle that wil be used.

Method Summary

Modifier and Type	Method and Description
PortablePermission[]	getCodeSourcePermissions(PortableCodeSource codeSource) Returns the permissions granted to the passed in code source.
java.util.Map<java.lang.String,java.lang.String>	getConfigurationProperties() Function to return the configuration parameters that are associated with the Store.
PortablePermission[]	getPermissions(PortablePrincipal principal) Returns the permissions granted to the passed in principal.
oracle.security.jps.service.policystore.PolicyStoreType	getStoreType() Function to get the Type of the Store.
PortableJavaPolicy	getSystemPolicy() Function to return the System (Global) Policy associated with the Store.
void	grantToSystemPolicy(PortableGrant[] arrPortableGrant) Function to add grants to the System (Global) Policy.
void	persist() Function to save the policy store after changes have been made.
void	refresh() Function to make the Policy store to reload information from the storage.
void	revokeFromSystemPolicy(PortableGrant[] arrPortableGrants) Function to remove grants from the System (Global) Policy.

Field Detail

RBN

static final java.lang.String RBN

Data member to hold the Resource Bundle that wil be used.

See Also:

Constant Field Values

Method Detail

getStoreType

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.getStoreType",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=0)
oracle.security.jps.service.policystore.PolicyStoreType getStoreType()
                                                                                                                                                                                                                                                                            throws oracle.as.jmx.framework.exceptions.ManagementException,
                                                                                                                                                                                                                                                                                   java.io.IOException

Function to get the Type of the Store.

Returns:

PolicyStoreType which represent the type of the Policy 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

getConfigurationProperties

@Description(resourceKey="oracle.security.jps.management.JpsPolicyStoreMXBean.getConfigurationProperties",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=0)
java.util.Map<java.lang.String,java.lang.String> getConfigurationProperties()
                                                                                                                                                                                                                                                                                                 throws oracle.as.jmx.framework.exceptions.ManagementException,
                                                                                                                                                                                                                                                                                                        java.io.IOException

Function to return the configuration parameters that are associated with the Store. The Map contains pairing of the name of the property to the value. The exact names are to be still worked out.

Returns:

Map which contains the configuratioin entries

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

getSystemPolicy

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

Function to return the System (Global) Policy associated with the Store.

Returns:

PortableJavaPolicy which holds the information related to the System (Global) Policy

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

grantToSystemPolicy

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

Function to add grants to the System (Global) Policy.

Parameters:

arrPortableGrant - Array of Grant which has to be given 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

revokeFromSystemPolicy

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

Function to remove grants from the System (Global) Policy.

Parameters:

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

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

persist

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

Function to save the policy store after changes have been made. In case of an Ldap Store it would not be useful as any change would write the data directly to Ldap. Only in case of xml would it be useful where the write to the file can be controlled.

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

refresh

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

Function to make the Policy store to reload information from the storage.

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(PortablePrincipal principal)
                                                                                                                                                                                                                                             throws oracle.as.jmx.framework.exceptions.ManagementException,
                                                                                                                                                                                                                                                    java.io.IOException

Returns the permissions granted to the passed in principal.

Parameters:

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

getCodeSourcePermissions

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

Returns the permissions granted to the passed in code source.

Parameters:

codeSource - PortableCodeSource

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