org.glassfish.deployment.common

Class DeploymentProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

org.glassfish.deployment.common.DeploymentProperties

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public class DeploymentProperties
extends Properties

This properties are used to transfer information between deployment clients and server

Author:

Sandhya E

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALT_DD
static String	APP_CONFIG
static String	APP_PROPS
static String	ARCHIVE_NAME
static String	AVAILABILITY_ENABLED
static String	CASCADE
static String	CLIENTJARREQUESTED
static String	COMMAND_PARAMS
static String	COMPATIBILITY
static String	CONTEXT_PATH
static String	CONTEXT_ROOT
static String	DD_CONTENT
static String	DD_PATH
static String	DEFAULT_APP_NAME
static String	DEFAULT_AVAILABILITY_ENABLED
static String	DEFAULT_CASCADE
static String	DEFAULT_ENABLED
static String	DEFAULT_EXTERNALLY_MANAGED
static String	DEFAULT_FORCE
static String	DEFAULT_GENERATE_RMI_STUBS
static String	DEFAULT_JAVA_WEB_START_ENABLED
static String	DEFAULT_PRECOMPILE_JSP
static String	DEFAULT_REDEPLOY
static String	DEFAULT_RELOAD
static String	DEFAULT_UPLOAD
static String	DEFAULT_VERIFY
static String	DEFAULT_VIRTUAL_SERVERS
static String	DEPLOY_OPTION_AVAILABILITY_ENABLED_KEY
static String	DEPLOY_OPTION_CASCADE_KEY
static String	DEPLOY_OPTION_CONTEXT_ROOT_KEY
static String	DEPLOY_OPTION_DESCRIPTION_KEY
static String	DEPLOY_OPTION_ENABLED_KEY
static String	DEPLOY_OPTION_FORCE_KEY
static String	DEPLOY_OPTION_GENERATE_RMI_STUBS_KEY
static String	DEPLOY_OPTION_JAVA_WEB_START_ENABLED_KEY
static String	DEPLOY_OPTION_LIBRARIES_KEY
static String	DEPLOY_OPTION_NAME_KEY
static String	DEPLOY_OPTION_PRECOMPILE_JSP_KEY
static String	DEPLOY_OPTION_VERIFY_KEY
static String	DEPLOY_OPTION_VIRTUAL_SERVERS_KEY
static String	DEPLOYMENT_PLAN
static String	DESCRIPTION
static String	DROP_TABLES
static String	ENABLED
static String	EXTERNALLY_MANAGED
static String	FORCE
static String	GENERATE_RMI_STUBS
static String	HOST
static String	IGNORE_CASCADE
static String	IS_REDEPLOY
static String	IS_SNIFFER_USER_VISIBLE
static String	IS_UNDEPLOY
static String	KEEP_REPOSITORY_DIRECTORY
static String	KEEP_SESSIONS
static String	KEEP_STATE
static String	KEY_PREFIX
static String	LOG_REPORTED_ERRORS
static String	MODULE_ID
static String	MODULE_INFO
static String	MODULE_NAME
static String	NAME
static String	PATH
static String	PORT
static String	PRECOMPILE_JSP
static String	PRESERVE_APP_SCOPED_RESOURCES
static String	PRESERVED_CONTEXT_ROOT
static String	PREVIOUS_ENABLED_ATTRIBUTES
static String	PREVIOUS_TARGETS
static String	PREVIOUS_VIRTUAL_SERVERS
static String	PROTOCOL
static String	REDEPLOY
static String	REDEPLOY_CONTEXT_PROPERTIES
static String	RELOAD
static String	RES_CREATE_REF
static String	RES_DELETE_REF
static String	RES_DEPLOYMENT
static String	RES_NO_OP
static String	RES_REDEPLOYMENT
static String	RES_UNDEPLOYMENT
static String	RESOURCE_ACTION
static String	RESOURCE_TARGET_LIST
static String	RUNTIME_ALT_DD
static String	SKIP_SCAN_EXTERNAL_LIB
static String	SNIFFERS
static String	STATE
static String	SYSTEM_ADMIN
static String	SYSTEM_ALL
static String	TARGET
static String	TYPE
static String	UPLOAD
static String	VERIFY
static String	VIRTUAL_SERVERS
static String	WSDL_TARGET_HINT

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
DeploymentProperties() Construct an empty DeploymentProperties
DeploymentProperties(Map map) Construct a DeploymentProperties using the map passed from client For keys defined before AMX time, since different keys were defined in the DeploymentMgrMBean, we need to do conversion between the keys to keep backward compatibilities For internal keys and the new keys defined after AMX time, we don't need to do any conversion
DeploymentProperties(Properties props) Construct a DeploymentProperties using the props

Method Summary

Modifier and Type	Method and Description
String	getArchiveName()
boolean	getAvailabilityEnabled()
boolean	getCascade()
String	getContextRoot()
String	getDefaultContextRoot(String filePath)
String	getDescription()
boolean	getEnabled()
boolean	getExternallyManaged()
boolean	getForce()
boolean	getGenerateRMIStubs()
boolean	getJavaWebStartEnabled()
String	getLibraries()
String	getName(String filePath)
String	getPath()
boolean	getPrecompileJSP()
Properties	getPropertiesForInvoke()
boolean	getRedeploy()
boolean	getReload()
String	getResourceAction()
String	getResourceTargetList()
String	getTarget()
boolean	getUpload()
boolean	getVerify()
String	getVirtualServers()
String	getWsdlTargetHint() This set of get and set for WSDL_TARGET_HINT is to enable back generate WSDL with the host and port info of the actual server target in case only one target has been specified by the client; Refer to bug ID 6157923 for more details
static Map	propsToMap(Properties dProps) Construct a map with the keys defined in DeploymentMgrMBean this is used when the ASAPI client convert the props from the client to a map to invoke DeploymentMgrMBean API For keys defined before AMX time, since different keys were defined in the DeploymentMgrMBean, we need to do conversion between the keys to keep backward compatibilities For internal keys and the new keys defined after AMX time, we don't need to do any conversion
Properties	prune()
void	setArchiveName(String archiveName)
void	setAvailabilityEnabled(boolean availabilityEnabled)
void	setCascade(boolean cascade)
void	setContextRoot(String contextRoot)
void	setDescription(String description)
void	setEnabled(boolean enabled)
void	setExternallyManaged(boolean isExternallyManaged)
void	setForce(boolean force)
void	setGenerateRMIStubs(boolean generateRMIStubs)
void	setJavaWebStartEnabled(boolean javaWebStartEnabled)
void	setLibraries(String libraries)
void	setName(String name)
void	setPath(String path)
void	setPrecompileJSP(boolean precompileJSP)
void	setRedeploy(boolean redeploy)
void	setReload(boolean reload)
void	setResourceAction(String resourceAction)
void	setResourceTargetList(String resTargetList)
void	setTarget(String target)
void	setUpload(boolean uploadEnabled)
void	setVerify(boolean verify)
void	setVirtualServers(String virtualServers)
void	setWsdlTargetHint(String target)

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

WSDL_TARGET_HINT

public static final String WSDL_TARGET_HINT

See Also:

Constant Field Values

TARGET

public static final String TARGET

See Also:

Constant Field Values

REDEPLOY

public static final String REDEPLOY

See Also:

Constant Field Values

DEFAULT_REDEPLOY

public static final String DEFAULT_REDEPLOY

See Also:

Constant Field Values

FORCE

public static final String FORCE

See Also:

Constant Field Values

DEFAULT_FORCE

public static final String DEFAULT_FORCE

See Also:

Constant Field Values

RELOAD

public static final String RELOAD

See Also:

Constant Field Values

DEFAULT_RELOAD

public static final String DEFAULT_RELOAD

See Also:

Constant Field Values

CASCADE

public static final String CASCADE

See Also:

Constant Field Values

DEFAULT_CASCADE

public static final String DEFAULT_CASCADE

See Also:

Constant Field Values

VERIFY

public static final String VERIFY

See Also:

Constant Field Values

DEFAULT_VERIFY

public static final String DEFAULT_VERIFY

See Also:

Constant Field Values

VIRTUAL_SERVERS

public static final String VIRTUAL_SERVERS

See Also:

Constant Field Values

DEFAULT_VIRTUAL_SERVERS

public static final String DEFAULT_VIRTUAL_SERVERS

PRECOMPILE_JSP

public static final String PRECOMPILE_JSP

See Also:

Constant Field Values

DEFAULT_PRECOMPILE_JSP

public static final String DEFAULT_PRECOMPILE_JSP

See Also:

Constant Field Values

GENERATE_RMI_STUBS

public static final String GENERATE_RMI_STUBS

See Also:

Constant Field Values

DEFAULT_GENERATE_RMI_STUBS

public static final String DEFAULT_GENERATE_RMI_STUBS

See Also:

Constant Field Values

AVAILABILITY_ENABLED

public static final String AVAILABILITY_ENABLED

See Also:

Constant Field Values

DEFAULT_AVAILABILITY_ENABLED

public static final String DEFAULT_AVAILABILITY_ENABLED

See Also:

Constant Field Values

ENABLED

public static final String ENABLED

See Also:

Constant Field Values

DEFAULT_ENABLED

public static final String DEFAULT_ENABLED

See Also:

Constant Field Values

CONTEXT_ROOT

public static final String CONTEXT_ROOT

See Also:

Constant Field Values

ARCHIVE_NAME

public static final String ARCHIVE_NAME

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

Constant Field Values

CLIENTJARREQUESTED

public static final String CLIENTJARREQUESTED

See Also:

Constant Field Values

UPLOAD

public static final String UPLOAD

See Also:

Constant Field Values

EXTERNALLY_MANAGED

public static final String EXTERNALLY_MANAGED

See Also:

Constant Field Values

PATH

public static final String PATH

See Also:

Constant Field Values

COMPATIBILITY

public static final String COMPATIBILITY

See Also:

Constant Field Values

DEFAULT_APP_NAME

public static final String DEFAULT_APP_NAME

See Also:

Constant Field Values

MODULE_ID

public static final String MODULE_ID

See Also:

Constant Field Values

KEY_PREFIX

public static final String KEY_PREFIX

See Also:

Constant Field Values

DEPLOY_OPTION_FORCE_KEY

public static final String DEPLOY_OPTION_FORCE_KEY

See Also:

Constant Field Values

DEPLOY_OPTION_CASCADE_KEY

public static final String DEPLOY_OPTION_CASCADE_KEY

See Also:

Constant Field Values

DEPLOY_OPTION_VERIFY_KEY

public static final String DEPLOY_OPTION_VERIFY_KEY

See Also:

Constant Field Values

DEPLOY_OPTION_VIRTUAL_SERVERS_KEY

public static final String DEPLOY_OPTION_VIRTUAL_SERVERS_KEY

See Also:

Constant Field Values

DEPLOY_OPTION_PRECOMPILE_JSP_KEY

public static final String DEPLOY_OPTION_PRECOMPILE_JSP_KEY

See Also:

Constant Field Values

DEPLOY_OPTION_ENABLED_KEY

public static final String DEPLOY_OPTION_ENABLED_KEY

See Also:

Constant Field Values

DEPLOY_OPTION_CONTEXT_ROOT_KEY

public static final String DEPLOY_OPTION_CONTEXT_ROOT_KEY

See Also:

Constant Field Values

DEPLOY_OPTION_NAME_KEY

public static final String DEPLOY_OPTION_NAME_KEY

See Also:

Constant Field Values

DEPLOY_OPTION_DESCRIPTION_KEY

public static final String DEPLOY_OPTION_DESCRIPTION_KEY

See Also:

Constant Field Values

DEPLOY_OPTION_GENERATE_RMI_STUBS_KEY

public static final String DEPLOY_OPTION_GENERATE_RMI_STUBS_KEY

See Also:

Constant Field Values

DEPLOY_OPTION_AVAILABILITY_ENABLED_KEY

public static final String DEPLOY_OPTION_AVAILABILITY_ENABLED_KEY

See Also:

Constant Field Values

DEPLOYMENT_PLAN

public static final String DEPLOYMENT_PLAN

See Also:

Constant Field Values

DEPLOY_OPTION_JAVA_WEB_START_ENABLED_KEY

public static final String DEPLOY_OPTION_JAVA_WEB_START_ENABLED_KEY

See Also:

Constant Field Values

DEPLOY_OPTION_LIBRARIES_KEY

public static final String DEPLOY_OPTION_LIBRARIES_KEY

See Also:

Constant Field Values

DEFAULT_JAVA_WEB_START_ENABLED

public static final String DEFAULT_JAVA_WEB_START_ENABLED

See Also:

Constant Field Values

DEFAULT_UPLOAD

public static final String DEFAULT_UPLOAD

See Also:

Constant Field Values

DEFAULT_EXTERNALLY_MANAGED

public static final String DEFAULT_EXTERNALLY_MANAGED

See Also:

Constant Field Values

RESOURCE_ACTION

public static final String RESOURCE_ACTION

See Also:

Constant Field Values

RESOURCE_TARGET_LIST

public static final String RESOURCE_TARGET_LIST

See Also:

Constant Field Values

RES_DEPLOYMENT

public static final String RES_DEPLOYMENT

See Also:

Constant Field Values

RES_CREATE_REF

public static final String RES_CREATE_REF

See Also:

Constant Field Values

RES_DELETE_REF

public static final String RES_DELETE_REF

See Also:

Constant Field Values

RES_UNDEPLOYMENT

public static final String RES_UNDEPLOYMENT

See Also:

Constant Field Values

RES_REDEPLOYMENT

public static final String RES_REDEPLOYMENT

See Also:

Constant Field Values

RES_NO_OP

public static final String RES_NO_OP

See Also:

Constant Field Values

APP_CONFIG

public static final String APP_CONFIG

See Also:

Constant Field Values

STATE

public static final String STATE

See Also:

Constant Field Values

MODULE_INFO

public static final String MODULE_INFO

See Also:

Constant Field Values

MODULE_NAME

public static final String MODULE_NAME

See Also:

Constant Field Values

DD_PATH

public static final String DD_PATH

See Also:

Constant Field Values

DD_CONTENT

public static final String DD_CONTENT

See Also:

Constant Field Values

SYSTEM_ADMIN

public static final String SYSTEM_ADMIN

See Also:

Constant Field Values

SYSTEM_ALL

public static final String SYSTEM_ALL

See Also:

Constant Field Values

PREVIOUS_TARGETS

public static final String PREVIOUS_TARGETS

See Also:

Constant Field Values

PREVIOUS_VIRTUAL_SERVERS

public static final String PREVIOUS_VIRTUAL_SERVERS

See Also:

Constant Field Values

PREVIOUS_ENABLED_ATTRIBUTES

public static final String PREVIOUS_ENABLED_ATTRIBUTES

See Also:

Constant Field Values

PRESERVED_CONTEXT_ROOT

public static final String PRESERVED_CONTEXT_ROOT

See Also:

Constant Field Values

APP_PROPS

public static final String APP_PROPS

See Also:

Constant Field Values

IS_REDEPLOY

public static final String IS_REDEPLOY

See Also:

Constant Field Values

IS_UNDEPLOY

public static final String IS_UNDEPLOY

See Also:

Constant Field Values

IGNORE_CASCADE

public static final String IGNORE_CASCADE

See Also:

Constant Field Values

KEEP_STATE

public static final String KEEP_STATE

See Also:

Constant Field Values

DROP_TABLES

public static final String DROP_TABLES

See Also:

Constant Field Values

ALT_DD

public static final String ALT_DD

See Also:

Constant Field Values

RUNTIME_ALT_DD

public static final String RUNTIME_ALT_DD

See Also:

Constant Field Values

COMMAND_PARAMS

public static final String COMMAND_PARAMS

See Also:

Constant Field Values

PROTOCOL

public static final String PROTOCOL

See Also:

Constant Field Values

HOST

public static final String HOST

See Also:

Constant Field Values

PORT

public static final String PORT

See Also:

Constant Field Values

CONTEXT_PATH

public static final String CONTEXT_PATH

See Also:

Constant Field Values

KEEP_REPOSITORY_DIRECTORY

public static final String KEEP_REPOSITORY_DIRECTORY

See Also:

Constant Field Values

REDEPLOY_CONTEXT_PROPERTIES

public static final String REDEPLOY_CONTEXT_PROPERTIES

See Also:

Constant Field Values

LOG_REPORTED_ERRORS

public static final String LOG_REPORTED_ERRORS

See Also:

Constant Field Values

KEEP_SESSIONS

public static final String KEEP_SESSIONS

See Also:

Constant Field Values

PRESERVE_APP_SCOPED_RESOURCES

public static final String PRESERVE_APP_SCOPED_RESOURCES

See Also:

Constant Field Values

IS_SNIFFER_USER_VISIBLE

public static final String IS_SNIFFER_USER_VISIBLE

See Also:

Constant Field Values

SKIP_SCAN_EXTERNAL_LIB

public static final String SKIP_SCAN_EXTERNAL_LIB

See Also:

Constant Field Values

SNIFFERS

public static final String SNIFFERS

See Also:

Constant Field Values

Constructor Detail

DeploymentProperties

public DeploymentProperties()

Construct an empty DeploymentProperties

DeploymentProperties

public DeploymentProperties(Properties props)

Construct a DeploymentProperties using the props

Parameters:

props -

DeploymentProperties

public DeploymentProperties(Map map)

Construct a DeploymentProperties using the map passed from client

1. For keys defined before AMX time, since different keys were defined in the DeploymentMgrMBean, we need to do conversion between the keys to keep backward compatibilities
2. For internal keys and the new keys defined after AMX time, we don't need to do any conversion

Method Detail

propsToMap

public static Map propsToMap(Properties dProps)

Construct a map with the keys defined in DeploymentMgrMBean this is used when the ASAPI client convert the props from the client to a map to invoke DeploymentMgrMBean API

1. For keys defined before AMX time, since different keys were defined in the DeploymentMgrMBean, we need to do conversion between the keys to keep backward compatibilities
2. For internal keys and the new keys defined after AMX time, we don't need to do any conversion

getWsdlTargetHint

public String getWsdlTargetHint()
                         throws IllegalArgumentException

This set of get and set for WSDL_TARGET_HINT is to enable back generate WSDL with the host and port info of the actual server target in case only one target has been specified by the client; Refer to bug ID 6157923 for more details

Throws:

IllegalArgumentException

setWsdlTargetHint

public void setWsdlTargetHint(String target)

getTarget

public String getTarget()
                 throws IllegalArgumentException

Throws:

IllegalArgumentException

setTarget

public void setTarget(String target)

getRedeploy

public boolean getRedeploy()

setRedeploy

public void setRedeploy(boolean redeploy)

getArchiveName

public String getArchiveName()
                      throws IllegalArgumentException

Throws:

IllegalArgumentException

setArchiveName

public void setArchiveName(String archiveName)

getForce

public boolean getForce()

setForce

public void setForce(boolean force)

getReload

public boolean getReload()

setReload

public void setReload(boolean reload)

getCascade

public boolean getCascade()

setCascade

public void setCascade(boolean cascade)

getPrecompileJSP

public boolean getPrecompileJSP()

setPrecompileJSP

public void setPrecompileJSP(boolean precompileJSP)

getVerify

public boolean getVerify()

setVerify

public void setVerify(boolean verify)

getVirtualServers

public String getVirtualServers()

setVirtualServers

public void setVirtualServers(String virtualServers)

getEnabled

public boolean getEnabled()

setEnabled

public void setEnabled(boolean enabled)

getContextRoot

public String getContextRoot()

setContextRoot

public void setContextRoot(String contextRoot)

getName

public String getName(String filePath)

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getGenerateRMIStubs

public boolean getGenerateRMIStubs()

setGenerateRMIStubs

public void setGenerateRMIStubs(boolean generateRMIStubs)

getAvailabilityEnabled

public boolean getAvailabilityEnabled()

setAvailabilityEnabled

public void setAvailabilityEnabled(boolean availabilityEnabled)

getJavaWebStartEnabled

public boolean getJavaWebStartEnabled()

setJavaWebStartEnabled

public void setJavaWebStartEnabled(boolean javaWebStartEnabled)

getLibraries

public String getLibraries()

setLibraries

public void setLibraries(String libraries)

getResourceAction

public String getResourceAction()

setResourceAction

public void setResourceAction(String resourceAction)

getResourceTargetList

public String getResourceTargetList()

setResourceTargetList

public void setResourceTargetList(String resTargetList)

setUpload

public void setUpload(boolean uploadEnabled)

getUpload

public boolean getUpload()

setExternallyManaged

public void setExternallyManaged(boolean isExternallyManaged)

setPath

public void setPath(String path)

getPath

public String getPath()

getExternallyManaged

public boolean getExternallyManaged()

getPropertiesForInvoke

public Properties getPropertiesForInvoke()

prune

public Properties prune()

getDefaultContextRoot

public String getDefaultContextRoot(String filePath)