Package org.glassfish.deployment.admin

Class DeployCommand

java.lang.Object

org.glassfish.api.deployment.OpsParams

org.glassfish.api.deployment.DeployCommandParameters

org.glassfish.deployment.admin.DeployCommand

All Implemented Interfaces:

AdminCommand, AdminCommandSecurity.AccessCheckProvider, AdminCommandSecurity.Preauthorization, CommandParameters, EventListener

Direct Known Subclasses:

DeployDirCommand

@Service(name="deploy")
@PerLookup
@ExecuteOn(DAS)
@TargetType({DOMAIN,DAS,STANDALONE_INSTANCE,CLUSTER,DEPLOYMENT_GROUP})
public class DeployCommand
extends DeployCommandParameters
implements AdminCommand, EventListener, AdminCommandSecurity.Preauthorization, AdminCommandSecurity.AccessCheckProvider

Deploy command

Author:

Jerome Dochez

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeployCommand.Interceptor	Crude interception mechanisms for deploy comamnd execution

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

DeployCommandParameters.ParameterNames

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

OpsParams.Command, OpsParams.Origin

Nested classes/interfaces inherited from interface org.glassfish.api.event.EventListener

EventListener.Event<T>

Field Summary

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

altdd, asyncreplication, availabilityenabled, clientJarRequested, contextroot, createtables, dbvendorname, deploymentorder, deploymentplan, description, dropandcreatetables, enabled, force, forceName, generatermistubs, hotDeploy, isredeploy, keepfailedstubs, keepreposdir, keepstate, lbenabled, libraries, loadOnly, logReportedErrors, metadataChanged, name, path, precompilejsp, previousContextRoot, properties, property, retrieve, runtimealtdd, skipDSFailure, sourcesChanged, target, type, uniquetablenames, verify, virtualservers

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

_classicstyle, command, origin

Constructor Summary

Constructors

Constructor	Description
DeployCommand()

Method Summary

Modifier and Type	Method	Description
void	event(EventListener.Event event)	Process a Glassfish/Payara event
void	execute(AdminCommandContext context)	Entry point from the framework into the command execution
Collection<? extends AccessRequired.AccessCheck>	getAccessChecks()	Returns the AccessChecks the command has computed at runtime which should be included in the authorization, added to checks that secure admin infers from the command's CRUD or RestEndpoint characteristics or AccessRequired annotations.
boolean	preAuthorization(AdminCommandContext context)
static void	retrieveArtifacts(AdminCommandContext context, Application app, String targetLocalDir)	Places into the outgoing payload the downloadable artifacts for an application.
static void	retrieveArtifacts(AdminCommandContext context, Application app, String targetLocalDir, boolean reportErrorsInTopReport)	Places into the outgoing payload the downloadable artifacts for an application.

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

getAltdd, getContextRoot, getDBVendorName, getDeploymentPlan, getPath, getPreviousContextRoot, getRetrieve, getRuntimeAltdd, getSourcesChanged, getType, getVirtualServers, isAsyncReplication, isAvailabilityEnabled, isClientJarRequested, isEnabled, isForce, isForceName, isGenerateRMIStubs, isHotDeploy, isKeepFailedStubs, isKeepReposDir, isLoadOnly, isLogReportedErrors, isMetadataChanged, isPrecompileJsp, isRedeploy, isSkipDSFailure, isVerify, libraries, name, setContextRoot

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

Constructor Detail

DeployCommand

public DeployCommand()

Method Detail

preAuthorization

public boolean preAuthorization(AdminCommandContext context)

Specified by:

preAuthorization in interface AdminCommandSecurity.Preauthorization

getAccessChecks

public Collection<? extends AccessRequired.AccessCheck> getAccessChecks()

Description copied from interface: AdminCommandSecurity.AccessCheckProvider

Returns the AccessChecks the command has computed at runtime which should be included in the authorization, added to checks that secure admin infers from the command's CRUD or RestEndpoint characteristics or AccessRequired annotations.

Specified by:

getAccessChecks in interface AdminCommandSecurity.AccessCheckProvider

Returns:

the AccessChecks

execute

public void execute(AdminCommandContext context)

Entry point from the framework into the command execution

Specified by:

execute in interface AdminCommand

Parameters:

context - context for the command.

retrieveArtifacts

public static void retrieveArtifacts(AdminCommandContext context,
                                     Application app,
                                     String targetLocalDir)

Places into the outgoing payload the downloadable artifacts for an application.

Parameters:

context - the admin command context for the command requesting the artifacts download

app - the application of interest

targetLocalDir - the client-specified local directory to receive the downloaded files

retrieveArtifacts

public static void retrieveArtifacts(AdminCommandContext context,
                                     Application app,
                                     String targetLocalDir,
                                     boolean reportErrorsInTopReport)

Places into the outgoing payload the downloadable artifacts for an application.

Parameters:

context - the admin command context for the command currently running

app - the application of interest

targetLocalDir - the client-specified local directory to receive the downloaded files

reportErrorsInTopReport - whether to include error indications in the report's top-level

event

public void event(EventListener.Event event)

Description copied from interface: EventListener

Process a Glassfish/Payara event

Specified by:

event in interface EventListener