Oracle Entitlements Server for Java API Reference

com.bea.security
Class SecurityRuntime

java.lang.Object
  |
  +--com.bea.security.SecurityRuntime

public class SecurityRuntime
extends java.lang.Object

The SecurityRuntime class provides a way to query the runtime for its capabilities and to create instances of policy domains for use in an application, as well as fetch several other application level resources.

Author:
Copyright © 2004-2008, Oracle and/or its affiliates. All rights reserved.

Method Summary
 boolean doesPolicyDomainExist(java.lang.String policydomainname)
          Determines if a specific policy domain exists.
 AuthenticIdentity getAnonymousIdentity()
          Gets the AuthenticIdentity of the ANONYMOUS user.
static SecurityRuntime getInstance()
          Gets a reference to the instance of the security runtime.
 NamingAuthorityManager getNamingAuthorityManager()
          Gets the naming authority manager for this runtime.
 PolicyDomain getPolicyDomain(java.lang.String policydomainname)
          Gets the policy domain associated with the name requested.
static void initialize(AppConfig config)
          Initializes the runtime according to the application specific configuration provided.
static void shutdown()
          Shuts down the runtime and returns it to a pre-initialized state.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

initialize

public static void initialize(AppConfig config)
                       throws ParameterException
Initializes the runtime according to the application specific configuration provided.

Parameters:
config - an AppConfig object that contains configuration information for this runtime.
Throws:
ServiceNotAvailableException - if initialization did not succeed.

shutdown

public static void shutdown()
Shuts down the runtime and returns it to a pre-initialized state.

getInstance

public static SecurityRuntime getInstance()
Gets a reference to the instance of the security runtime.

Returns:
a reference to the SecurityRuntime for this application.

getAnonymousIdentity

public AuthenticIdentity getAnonymousIdentity()
Gets the AuthenticIdentity of the ANONYMOUS user.

Returns:
the AuthenticIdentity used by the ANONYMOUS user.

doesPolicyDomainExist

public boolean doesPolicyDomainExist(java.lang.String policydomainname)
Determines if a specific policy domain exists.

Parameters:
policydomainname - the policy domain name as a String.
Returns:
true if the policy domain is known by the runtime; otherwise, returns false.

getPolicyDomain

public PolicyDomain getPolicyDomain(java.lang.String policydomainname)
                             throws ParameterException
Gets the policy domain associated with the name requested.

Parameters:
policydomainname - the name of the policy domain being requested.
Returns:
the PolicyDomain object that contains services for the domain requested.

getNamingAuthorityManager

public NamingAuthorityManager getNamingAuthorityManager()
Gets the naming authority manager for this runtime.

Returns:
a reference to the NamingAuthorityManager for this runtime. All names are managed according to the authorities registered to this manager.