DeployCommandParameters (Payara Project 5.2020.4 API)

java.lang.Object
- org.glassfish.api.deployment.OpsParams
- - org.glassfish.api.deployment.DeployCommandParameters

All Implemented Interfaces:

CommandParameters

Direct Known Subclasses:

DeployCommand, DeployRemoteArchiveCommand, InstanceDeployCommandParameters, PostDeployCommand, ReDeployCommand, ValidateRemoteDirDeploymentCommand
```
public class DeployCommandParameters
extends OpsParams
```
Parameters passed by the user to a deployment request.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DeployCommandParameters.ParameterNames
- Nested classes/interfaces inherited from class org.glassfish.api.deployment.OpsParams
  OpsParams.Command, OpsParams.Origin

Nested Classes
Modifier and Type	Class and Description
`static class`	`DeployCommandParameters.ParameterNames`

Field Summary

Fields
Modifier and Type	Field and Description
`File`	`altdd`
`Boolean`	`asyncreplication`
`Boolean`	`availabilityenabled`
`Boolean`	`clientJarRequested`
`String`	`contextroot`
`Boolean`	`createtables` mutually exclusive with dropandcreatetables
`String`	`dbvendorname`
`Integer`	`deploymentorder`
`File`	`deploymentplan`
`String`	`description`
`Boolean`	`dropandcreatetables` mutually exclusive with createtables
`Boolean`	`enabled`
`Boolean`	`force`
`Boolean`	`forceName`
`Boolean`	`generatermistubs`
`Boolean`	`hotDeploy`
`Boolean`	`isredeploy`
`Boolean`	`keepfailedstubs`
`Boolean`	`keepreposdir`
`Boolean`	`keepstate`
`String`	`lbenabled`
`String`	`libraries`
`Boolean`	`loadOnly`
`Boolean`	`logReportedErrors`
`Boolean`	`metadataChanged`
`String`	`name`
`File`	`path`
`Boolean`	`precompilejsp`
`String`	`previousContextRoot`
`Properties`	`properties`
`Properties`	`property`
`String`	`retrieve`
`File`	`runtimealtdd`
`Boolean`	`skipDSFailure`
`String[]`	`sourcesChanged`
`String`	`target`
`String`	`type`
`Boolean`	`uniquetablenames`
`Boolean`	`verify`
`String`	`virtualservers`

Fields inherited from class org.glassfish.api.deployment.OpsParams
_classicstyle, command, origin

Constructor Summary

Constructors
Constructor and Description

DeployCommandParameters()

DeployCommandParameters(File path)

Constructors
Constructor and Description
`DeployCommandParameters()`
`DeployCommandParameters(File path)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`File`	`getAltdd()`
`String`	`getContextRoot()`
`String`	`getDBVendorName()`
`File`	`getDeploymentPlan()`
`File`	`getPath()`
`String`	`getPreviousContextRoot()`
`String`	`getRetrieve()`
`File`	`getRuntimeAltdd()`
`String[]`	`getSourcesChanged()`
`String`	`getType()`
`String`	`getVirtualServers()`
`Boolean`	`isAsyncReplication()`
`Boolean`	`isAvailabilityEnabled()`
`Boolean`	`isClientJarRequested()`
`Boolean`	`isEnabled()`
`Boolean`	`isForce()`
`Boolean`	`isForceName()`
`Boolean`	`isGenerateRMIStubs()`
`Boolean`	`isHotDeploy()`
`Boolean`	`isKeepFailedStubs()`
`Boolean`	`isKeepReposDir()`
`Boolean`	`isLoadOnly()`
`Boolean`	`isLogReportedErrors()`
`Boolean`	`isMetadataChanged()`
`Boolean`	`isPrecompileJsp()`
`Boolean`	`isRedeploy()`
`Boolean`	`isSkipDSFailure()`
`Boolean`	`isVerify()`
`String`	`libraries()` Libraries that are to used with the application.
`String`	`name()`
`void`	`setContextRoot(String val)`

Methods inherited from class org.glassfish.api.deployment.OpsParams
getCommand, getOrigin

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name
```
public String name
```

contextroot
```
public String contextroot
```

virtualservers
```
public String virtualservers
```

libraries
```
public String libraries
```

force
```
public Boolean force
```

hotDeploy
```
public Boolean hotDeploy
```

sourcesChanged
```
public String[] sourcesChanged
```

metadataChanged
```
public Boolean metadataChanged
```

forceName
```
public Boolean forceName
```

precompilejsp
```
public Boolean precompilejsp
```

verify
```
public Boolean verify
```

retrieve
```
public String retrieve
```

skipDSFailure
```
public Boolean skipDSFailure
```

dbvendorname
```
public String dbvendorname
```

createtables
```
public Boolean createtables
```
mutually exclusive with dropandcreatetables

dropandcreatetables
```
public Boolean dropandcreatetables
```
mutually exclusive with createtables

uniquetablenames
```
public Boolean uniquetablenames
```

deploymentplan
```
public File deploymentplan
```

altdd
```
public File altdd
```

runtimealtdd
```
public File runtimealtdd
```

enabled
```
public Boolean enabled
```

loadOnly
```
public Boolean loadOnly
```

generatermistubs
```
public Boolean generatermistubs
```

availabilityenabled
```
public Boolean availabilityenabled
```

asyncreplication
```
public Boolean asyncreplication
```

target
```
public String target
```

keepreposdir
```
public Boolean keepreposdir
```

keepfailedstubs
```
public Boolean keepfailedstubs
```

isredeploy
```
public Boolean isredeploy
```

logReportedErrors
```
public Boolean logReportedErrors
```

path
```
public File path
```

description
```
public String description
```

properties
```
public Properties properties
```

property
```
public Properties property
```

type
```
public String type
```

keepstate
```
public Boolean keepstate
```

lbenabled
```
public String lbenabled
```

deploymentorder
```
public Integer deploymentorder
```

clientJarRequested
```
public Boolean clientJarRequested
```

previousContextRoot
```
public String previousContextRoot
```

Constructor Detail

DeployCommandParameters
```
public DeployCommandParameters()
```

DeployCommandParameters

public DeployCommandParameters(File path)

Method Detail

getContextRoot
```
public String getContextRoot()
```

setContextRoot

public void setContextRoot(String val)

getVirtualServers
```
public String getVirtualServers()
```

isForce
```
public Boolean isForce()
```

isHotDeploy
```
public Boolean isHotDeploy()
```

getSourcesChanged
```
public String[] getSourcesChanged()
```

isMetadataChanged
```
public Boolean isMetadataChanged()
```

isForceName
```
public Boolean isForceName()
```

isPrecompileJsp
```
public Boolean isPrecompileJsp()
```

isVerify
```
public Boolean isVerify()
```

getRetrieve
```
public String getRetrieve()
```

isSkipDSFailure
```
public Boolean isSkipDSFailure()
```

getDBVendorName
```
public String getDBVendorName()
```

getDeploymentPlan
```
public File getDeploymentPlan()
```

getAltdd
```
public File getAltdd()
```

getRuntimeAltdd
```
public File getRuntimeAltdd()
```

isEnabled
```
public Boolean isEnabled()
```

isLoadOnly
```
public Boolean isLoadOnly()
```

isGenerateRMIStubs
```
public Boolean isGenerateRMIStubs()
```

isAvailabilityEnabled

public Boolean isAvailabilityEnabled()

isAsyncReplication
```
public Boolean isAsyncReplication()
```

isKeepReposDir
```
public Boolean isKeepReposDir()
```

isKeepFailedStubs
```
public Boolean isKeepFailedStubs()
```

isRedeploy
```
public Boolean isRedeploy()
```

isLogReportedErrors
```
public Boolean isLogReportedErrors()
```

getPath
```
public File getPath()
```

getType
```
public String getType()
```

isClientJarRequested
```
public Boolean isClientJarRequested()
```

getPreviousContextRoot

public String getPreviousContextRoot()

name
```
public String name()
```
Specified by:

name in class OpsParams

Returns:

the name of the application being deployed

libraries
```
public String libraries()
```
Description copied from class: OpsParams

Libraries that are to used with the application.
These libraries if local should be under lib/applibs

Specified by:

libraries in class OpsParams

Returns:

a comma separated list of JAR files

Class DeployCommandParameters

Nested Class Summary

Nested classes/interfaces inherited from class org.glassfish.api.deployment.OpsParams

Field Summary

Fields inherited from class org.glassfish.api.deployment.OpsParams

Constructor Summary

Method Summary

Methods inherited from class org.glassfish.api.deployment.OpsParams

Methods inherited from class java.lang.Object

Field Detail

name

contextroot

virtualservers

libraries

force

hotDeploy

sourcesChanged

metadataChanged

forceName

precompilejsp

verify

retrieve

skipDSFailure

dbvendorname

createtables

dropandcreatetables

uniquetablenames

deploymentplan

altdd

runtimealtdd

enabled

loadOnly

generatermistubs

availabilityenabled

asyncreplication

target

keepreposdir

keepfailedstubs

isredeploy

logReportedErrors

path

description

properties

property

type

keepstate

lbenabled

deploymentorder

clientJarRequested

previousContextRoot

Constructor Detail

DeployCommandParameters

DeployCommandParameters

Method Detail

getContextRoot

setContextRoot

getVirtualServers

isForce

isHotDeploy

getSourcesChanged

isMetadataChanged

isForceName

isPrecompileJsp

isVerify

getRetrieve

isSkipDSFailure

getDBVendorName

getDeploymentPlan

getAltdd

getRuntimeAltdd

isEnabled

isLoadOnly

isGenerateRMIStubs

isAvailabilityEnabled

isAsyncReplication

isKeepReposDir

isKeepFailedStubs

isRedeploy

isLogReportedErrors

getPath