Skip navigation links

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

static class

JpsStartup.RuntimeState

Constructor Summary

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,ContextConfiguration> ctxtCfgs, java.util.Map<java.lang.String,?> options)
Constructor for Startup instance of supported platforms.

Method Summary

JpsStartup.RuntimeState	getState() Get the state of OPSS
void	start() Boots up OPSS by initializing OPSS services This method wil set the state as STARTED if OPSS services initialized correctly.
void	stop() Shuts down OPSS services This method wil set the state as STOPPED if OPSS services initialized correctly.

Methods inherited from class java.lang.Object

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

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 "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,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 "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 wil set the state as STARTED 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- NOT_INITIALIZED: if jps-config.xml is not present JPS_CONFIG_AVAILABLE: if jps-config.xml present STARTUP_FAILED: if issue occurred in start() STARTED: if start() has no issues STOPPED: if stop() is been called

stop

public void stop()

Shuts down OPSS services This method wil set the state as STOPPED if OPSS services initialized correctly.

Skip navigation links