oracle.security.jps

Class JpsStartup

java.lang.Object

oracle.security.jps.JpsStartup

public class JpsStartup
extends java.lang.Object

JpsStartup class is responsible to start the OPSS on all platforms ( i.e. Weblogic, Tomcat, Jboss, Websphere) as well as standalone (JSE) programs. This class is single starting point of OPSS which supports all platform as mentioned above. OPSS Startup process is also dependent upon the startup options and system settings. Following are the startup options details Also it manages OPSS runtime states deriven by its operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JpsStartup.PlatformType
static class	JpsStartup.RuntimeState

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JPS_STARTUP_RETRY_COUNT
static int	JPS_STARTUP_RETRY_COUNT_DEFAULT
static int	JPS_STARTUP_RETRY_COUNT_WLS_DEFAULT
static java.lang.String	JPS_STARTUP_RETRY_INTERVAL
static int	JPS_STARTUP_RETRY_INTERVAL_DEFAULT

Constructor Summary

Constructors

Constructor and Description
JpsStartup() Default constructor for Java SE Startup
JpsStartup(java.lang.String platformType) Constructor for Startup instance of supported platforms.
JpsStartup(java.lang.String platformType, java.util.Map<java.lang.String,?> options) Constructor for Startup instance of supported platforms.
JpsStartup(java.lang.String platformType, java.util.Map<java.lang.String,oracle.security.opss.config.ContextConfiguration> ctxtCfgs, java.util.Map<java.lang.String,?> options) Constructor for Startup instance of supported platforms.

Method Summary

Modifier and Type	Method and Description
JpsStartup.RuntimeState	getState() Get the state of OPSS
void	postStart() Post Start Operations - invoked after JDBC/JMX resources are available and activated
void	reset() Resets OPSS runtime so that OPSS is back to the state before new JpsStartup() and JpsStartup.start() is called.
void	start() Boots up OPSS by initializing OPSS services This method will set the state as ACTIVE if OPSS services initialized correctly.
void	stop() Shuts down OPSS services.

Methods inherited from class java.lang.Object

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

Field Detail

JPS_STARTUP_RETRY_COUNT

public static final java.lang.String JPS_STARTUP_RETRY_COUNT

See Also:

Constant Field Values

JPS_STARTUP_RETRY_COUNT_DEFAULT

public static final int JPS_STARTUP_RETRY_COUNT_DEFAULT

See Also:

Constant Field Values

JPS_STARTUP_RETRY_COUNT_WLS_DEFAULT

public static final int JPS_STARTUP_RETRY_COUNT_WLS_DEFAULT

See Also:

Constant Field Values

JPS_STARTUP_RETRY_INTERVAL

public static final java.lang.String JPS_STARTUP_RETRY_INTERVAL

See Also:

Constant Field Values

JPS_STARTUP_RETRY_INTERVAL_DEFAULT

public static final int JPS_STARTUP_RETRY_INTERVAL_DEFAULT

See Also:

Constant Field Values

Constructor Detail

JpsStartup

public JpsStartup()
           throws JpsException

Default constructor for Java SE Startup

Throws:

JpsException

JpsStartup

public JpsStartup(java.lang.String platformType)
           throws JpsException

Constructor for Startup instance of supported platforms. the current supported platforms are JSE, WebLogic, WebSphere, JBoss.

Parameters:

platformType - supported platform type

Throws:

JpsException

JpsStartup

public JpsStartup(java.lang.String platformType,
                  java.util.Map<java.lang.String,?> options)
           throws JpsException

Constructor for Startup instance of supported platforms. the current supported platforms are JSE, WebLogic, WebSphere, JBoss.

Parameters:

platformType - supported platform type

options - options on creating the startup class. Following are the options "ACTIVE_CONTEXT": Name of default context if not passed used "default" "ENABLE_JAVA_POLICY_PROVIDER": if "FALSE" then not to set default OPSS as Java2 policy provider otherwise set "CONTEXT_FOR_POLICY_PROVIDER": if set use the specified context to init OPSS java policy provider otherwise default context "ENABLE_AUDIT_SERVICE_EXT": if "FALSE" then start audit service without audit monitoring thread and auditloader otherwise start "ENABLE_POLICY_STORE_SERVICE_EXT": if "FALSE" then start PDP (Policy Distribution Point) without policy change scanner thread. "ENABLE_DEPLOYMENT_HANDLING": if "FALSE" then deployment handlers are not created by default created "RUNTIME_MODE": if mode is "SCRIPT" then by default options i.e. ENABLE_JAVA_POLICY_PROVIDER ,ENABLE_AUDIT_SERVICE_EXT, ENABLE_POLICY_STORE_SERVICE_EXT, ENABLE_DEPLOYMENT_HANDLING to "FALSE" otherwise "DEFAULT" "JPS_CONFIG": if set use the specified pass otherwise default behaviour

Throws:

JpsException

JpsStartup

public JpsStartup(java.lang.String platformType,
                  java.util.Map<java.lang.String,oracle.security.opss.config.ContextConfiguration> ctxtCfgs,
                  java.util.Map<java.lang.String,?> options)
           throws JpsException

Constructor for Startup instance of supported platforms. the current supported platforms are JSE, WebLogic, WebSphere, JBoss.

Parameters:

platformType - supported platform type

ctxtCfgs - pass the ContextConfiguration's

options - options on creating the startup class. Following are the options "ACTIVE_CONTEXT": Name of default context if not passed then "default" key is used "ENABLE_JAVA_POLICY_PROVIDER": if "FALSE" then not to set default OPSS as Java2 policy provider otherwise set "CONTEXT_FOR_POLICY_PROVIDER": if set use the specified context to init OPSS java policy provider otherwise default context "ENABLE_AUDIT_SERVICE_EXT": if "FALSE" then start audit service without audit monitoring thread and auditloader otherwise start "ENABLE_POLICY_STORE_SERVICE_EXT": if "FALSE" then start PDP (Policy Distribution Point) without policy change scanner thread. "ENABLE_DEPLOYMENT_HANDLING": if "FALSE" then deployment handlers are not created by default created "RUNTIME_MODE": if mode is "SCRIPT" then by default options i.e. ENABLE_JAVA_POLICY_PROVIDER ,ENABLE_AUDIT_SERVICE_EXT, ENABLE_POLICY_STORE_SERVICE_EXT, ENABLE_DEPLOYMENT_HANDLING to "FALSE" otherwise "DEFAULT" "JPS_CONFIG": if set use the specified pass otherwise default behaviour

Throws:

JpsException

Method Detail

start

public void start()
           throws JpsException

Boots up OPSS by initializing OPSS services This method will set the state as ACTIVE if OPSS services initialized correctly.

Throws:

JpsException

getState

public JpsStartup.RuntimeState getState()

Get the state of OPSS

Returns:

This method will return one of the following OPSS runtime states- UNINITIALIZED: is initial state when JpsStartup object created INITIALIZING: is state when start() method gets called and OPSS services are initializing ACTIVE: if start() has no issues STARTUP_FAILED: if issue occurred in start() INACTIVE: if stop() is been called

stop

public void stop()

Shuts down OPSS services. This method can only be called if current state is ACTIVE. OPSS' state will be changed to INACTIVE after this method is called. After OPSS is stopped, it cannot be started again with the same JpsStartup instance.

reset

public void reset()
           throws JpsException

Resets OPSS runtime so that OPSS is back to the state before new JpsStartup() and JpsStartup.start() is called. This method can only be called if current state is INACTIVE. After resetting, the old instance of JpsStartup cannot be started again. To start OPSS again, a new instance of JpsStartup is required.

Throws:

JpsException

postStart

public void postStart()
               throws JpsException

Post Start Operations - invoked after JDBC/JMX resources are available and activated

Throws:

JpsException