com.sun.enterprise.security.ee

Class SecurityUtil

java.lang.Object

com.sun.enterprise.security.ee.SecurityUtil

public class SecurityUtil
extends Object

This utility class encloses all the calls to a ejb method in a specified subject

Author:

Harpreet Singh, Shing Wai Chan

Field Summary

Fields

Modifier and Type	Field and Description
static String	repository
static String	VENDOR_PRESENT

Constructor Summary

Constructors

Constructor and Description
SecurityUtil()

Method Summary

Modifier and Type	Method and Description
static void	generatePolicyFile(String name) This method obtains the policy configuration object corresponding to the name, and causes the corresponding policy statements to be put in service.
static String	getContextID(EjbBundleDescriptor ejbBundleDesc)
static String	getContextID(WebBundleDescriptor wbd)
static SecurityRoleMapperFactory	getRoleMapperFactory()
static boolean	linkPolicyFile(String name, String linkName, boolean lastInService) This method obtains the policy configuration object corresponding to the name, and links it, for roleMapping purposes to another.
static void	removePolicy(String name) Inform the policy module to take the named policy context out of service.
static void	removeRoleMapper(DeploymentContext dc)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VENDOR_PRESENT

public static final String VENDOR_PRESENT

See Also:

Constant Field Values

repository

public static final String repository

Constructor Detail

SecurityUtil

public SecurityUtil()

Method Detail

generatePolicyFile

public static void generatePolicyFile(String name)
                               throws IASSecurityException

This method obtains the policy configuration object corresponding to the name, and causes the corresponding policy statements to be put in service. This method also informs the policy module to refresh its in service policy contexts. Note that policy statements have already been added to the pc, this method works to put them in Service.

Parameters:

String - name - the module id which serves to identify the corresponding policy context. The name shall not be null. If the underlying PolicyModule is the RI PolicyModule, A SecurityRoleMapper must have been bound to the policy context before this method is called or the embedded call to pc.commit will throw an exception.

Throws:

IASSecurityException

removePolicy

public static void removePolicy(String name)
                         throws IASSecurityException

Inform the policy module to take the named policy context out of service. The policy context is transitioned to the deleted state. In our provider implementation, the corresponding policy file is deleted, as the presence of a policy file in the repository is how we persistently remember which policy contexts are in service.

Parameters:

String - name - the module id which serves to identify the corresponding policy context. The name shall not be null.

Throws:

IASSecurityException

linkPolicyFile

public static boolean linkPolicyFile(String name,
                                     String linkName,
                                     boolean lastInService)
                              throws IASSecurityException

This method obtains the policy configuration object corresponding to the name, and links it, for roleMapping purposes to another. If the pc is already InService when this method is called, this method does nothing.

Parameters:

String - name - the module id which serves to identify the corresponding policy context. The name shall not be null.

String - linkName - the module id of the module being linked to this context. This value may be null, in which case, no link is done, but the inService state of the named PC is returned.

boolean - lastInService - the inService state returned by the previous call to this method. The value of this argument is only significant when linkName is not null.

Returns:

boolean if linkName is null, returns the inService state of the PC identified in the name argument. Otherwise returns the value passed to lastInService.

Throws:

IASSecurityException

getContextID

public static String getContextID(EjbBundleDescriptor ejbBundleDesc)

getContextID

public static String getContextID(WebBundleDescriptor wbd)

removeRoleMapper

public static void removeRoleMapper(DeploymentContext dc)

getRoleMapperFactory

public static SecurityRoleMapperFactory getRoleMapperFactory()