com.sun.enterprise.admin.remote

Class RemoteRestAdminCommand

java.lang.Object

com.sun.enterprise.admin.event.AdminCommandEventBrokerImpl<GfSseInboundEvent>

com.sun.enterprise.admin.remote.RemoteRestAdminCommand

All Implemented Interfaces:

org.glassfish.api.admin.AdminCommandEventBroker<GfSseInboundEvent>

Direct Known Subclasses:

ServerRemoteRestAdminCommand

public class RemoteRestAdminCommand
extends AdminCommandEventBrokerImpl<GfSseInboundEvent>

Utility class for executing remote admin commands. Each instance of RemoteRestAdminCommand represents a particular remote command on a particular remote server accessed using particular credentials. The instance can be reused to execute the same command multiple times with different arguments.

Arguments to the command are supplied using a ParameterMap passed to the executeCommand method. ParameterMap is a MultiMap where each key can have multiple values, although this class only supports a single value for each option. Operands for the command are stored as the option named "DEFAULT" and can have multiple values.

Before a command can be executed, the metadata for the command (in the form of a CommandModel) is required. The getCommandModel method will fetch the metadata from the server, save it, and return it. If the CommandModel for a command is known independently (e.g., stored in a local cache, or known a priori), it can be set using the setCommandModel method. If the metadata isn't known when the exectureCommand method is called, it will fetch the metadata from the server before executing the command.

Any files returned by the command will be stored in the current directory. The setFileOutputDirectory method can be used to control where returned files are saved.

Nested Class Summary

Nested classes/interfaces inherited from interface org.glassfish.api.admin.AdminCommandEventBroker

org.glassfish.api.admin.AdminCommandEventBroker.AdminCommandListener<T>, org.glassfish.api.admin.AdminCommandEventBroker.BrokerListenerRegEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected String	authToken
static String	COMMAND_MODEL_MATCH_HEADER
protected String	host
protected Logger	logger
protected String	name
protected List<String>	operands
protected org.glassfish.api.admin.ParameterMap	options
protected String	output
protected String	password
protected int	port
protected boolean	prohibitDirectoryUploads
protected String	scope
protected boolean	secure
protected String	user

Fields inherited from interface org.glassfish.api.admin.AdminCommandEventBroker

LOCAL_EVENT_PREFIX

Constructor Summary

Constructors

Constructor and Description
RemoteRestAdminCommand(String name, String host, int port)
RemoteRestAdminCommand(String name, String host, int port, boolean secure, String user, String password, Logger logger)
RemoteRestAdminCommand(String name, String host, int port, boolean secure, String user, String password, Logger logger, String scope, String authToken, boolean prohibitDirectoryUploads) Construct a new remote command object.

Method Summary

Methods

Modifier and Type	Method and Description
protected javax.ws.rs.client.Invocation.Builder	addAdditionalHeaders(javax.ws.rs.client.Invocation.Builder request) Adds any headers needed for the current environment to the admin request.
protected AuthenticationInfo	authenticationInfo()
void	closeSse(String message, org.glassfish.api.ActionReport.ExitCode exitCode)
protected static SSLContext	createStandardSslContext(boolean interactive)
String	executeCommand(org.glassfish.api.admin.ParameterMap opts)
protected void	fetchCommandModel()
String	findPropertyInReport(String key)
org.glassfish.api.ActionReport	getActionReport()
protected String	getCanonicalHost()
org.glassfish.api.admin.CommandModel	getCommandModel() Get the CommandModel for the command from the server.
protected String	getFromEnvironment(String name) Subclasses can override to supply parameter values from environment.
String	getManPage()
static int	getReadTimeout()
protected SSLContext	getSslContext()
String	getUsage() Get the usage text.
List<Header>	headers() Return a modifiable list of headers to be added to the request.
boolean	isCommandModelFromCache() If command model was load from local cache.
static void	preinit() CLI can use this method to inicialise internal structures of used services like jersey and ssl in parallel with other logic
protected void	processHeaders(javax.ws.rs.core.Response headers) Process any headers needed from the reply to the admin request.
org.glassfish.api.admin.ParameterMap	processParams(org.glassfish.api.admin.ParameterMap opts) Run the command using the specified arguments.
protected boolean	refetchInvalidModel() If admin model is invalid, will be automatically refetched?
protected String	reportAuthenticationException() Return the error message to be used in the AuthenticationException.
protected boolean	retryUsingSecureConnection(String host, int port) Called when a non-secure connection attempt fails and it appears that the server requires a secure connection.
protected void	setActionReport(org.glassfish.api.ActionReport ar)
void	setCommandModel(org.glassfish.api.admin.CommandModel commandModel) Set the CommandModel used by this command.
void	setConnectTimeout(int connectTimeout) Set the connect timeout for the URLConnection.
void	setFileOutputDirectory(File dir) Set the directory in which any returned files will be stored.
void	setInteractive(boolean state) Set the interactive mode for the command.
void	setOmitCache(boolean omitCache) Omit local AdminCache to process command metadata.
void	setReadTimeout(int readTimeout) Set the read timeout for the URLConnection.
void	setResponseFormatType(String responseFormatType) Set the response type used in requests to the server.
void	setUserOut(OutputStream userOut) If set, the raw response from the command is written to the specified stream.
protected boolean	updateAuthentication() Return true if we're successful in collecting new information (and thus the caller should try the request again).
protected boolean	useSse()

Methods inherited from class com.sun.enterprise.admin.event.AdminCommandEventBrokerImpl

fireEvent, fireEvent, listening, registerListener, unregisterListener

Methods inherited from class java.lang.Object

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

Field Detail

COMMAND_MODEL_MATCH_HEADER

public static final String COMMAND_MODEL_MATCH_HEADER

See Also:

Constant Field Values

output

protected String output

name

protected String name

host

protected String host

port

protected int port

secure

protected boolean secure

user

protected String user

password

protected String password

logger

protected Logger logger

scope

protected String scope

authToken

protected String authToken

prohibitDirectoryUploads

protected boolean prohibitDirectoryUploads

options

protected org.glassfish.api.admin.ParameterMap options

operands

protected List<String> operands

Constructor Detail

RemoteRestAdminCommand

public RemoteRestAdminCommand(String name,
                      String host,
                      int port)
                       throws org.glassfish.api.admin.CommandException

Throws:

org.glassfish.api.admin.CommandException

RemoteRestAdminCommand

public RemoteRestAdminCommand(String name,
                      String host,
                      int port,
                      boolean secure,
                      String user,
                      String password,
                      Logger logger)
                       throws org.glassfish.api.admin.CommandException

Throws:

org.glassfish.api.admin.CommandException

RemoteRestAdminCommand

public RemoteRestAdminCommand(String name,
                      String host,
                      int port,
                      boolean secure,
                      String user,
                      String password,
                      Logger logger,
                      String scope,
                      String authToken,
                      boolean prohibitDirectoryUploads)
                       throws org.glassfish.api.admin.CommandException

Construct a new remote command object. The command and arguments are supplied later using the execute method in the superclass.

Throws:

org.glassfish.api.admin.CommandException

Method Detail

closeSse

public void closeSse(String message,
            org.glassfish.api.ActionReport.ExitCode exitCode)

setResponseFormatType

public void setResponseFormatType(String responseFormatType)

Set the response type used in requests to the server. The response type is sent in the User-Agent HTTP header and tells the server what format of response to produce.

setUserOut

public void setUserOut(OutputStream userOut)

If set, the raw response from the command is written to the specified stream.

setCommandModel

public void setCommandModel(org.glassfish.api.admin.CommandModel commandModel)

Set the CommandModel used by this command. Normally the CommandModel will be fetched from the server using the getCommandModel method, which will also save the CommandModel for further use. If the CommandModel is known in advance, it can be set with this method and avoid the call to the server.

setReadTimeout

public void setReadTimeout(int readTimeout)

Set the read timeout for the URLConnection.

getReadTimeout

public static int getReadTimeout()

getActionReport

public org.glassfish.api.ActionReport getActionReport()

findPropertyInReport

public String findPropertyInReport(String key)

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

Set the connect timeout for the URLConnection.

setInteractive

public void setInteractive(boolean state)

Set the interactive mode for the command. By default, the command is interactive.

setOmitCache

public void setOmitCache(boolean omitCache)

Omit local AdminCache to process command metadata. If true it will download the metadata from remote server.
Default value is false

getCommandModel

public org.glassfish.api.admin.CommandModel getCommandModel()
                                                     throws org.glassfish.api.admin.CommandException

Get the CommandModel for the command from the server. If the CommandModel hasn't been set, it's fetched from the server.

Returns:

the model for the command

Throws:

org.glassfish.api.admin.CommandException - if the server can't be contacted

isCommandModelFromCache

public boolean isCommandModelFromCache()

If command model was load from local cache.

setFileOutputDirectory

public void setFileOutputDirectory(File dir)

Set the directory in which any returned files will be stored. The default is the user's home directory.

headers

public List<Header> headers()

Return a modifiable list of headers to be added to the request.

useSse

protected boolean useSse()
                  throws org.glassfish.api.admin.CommandException

Throws:

org.glassfish.api.admin.CommandException

executeCommand

public String executeCommand(org.glassfish.api.admin.ParameterMap opts)
                      throws org.glassfish.api.admin.CommandException

Throws:

org.glassfish.api.admin.CommandException

setActionReport

protected void setActionReport(org.glassfish.api.ActionReport ar)

processParams

public org.glassfish.api.admin.ParameterMap processParams(org.glassfish.api.admin.ParameterMap opts)
                                                   throws org.glassfish.api.admin.CommandException

Run the command using the specified arguments. Return the output of the command.

Throws:

org.glassfish.api.admin.CommandException

updateAuthentication

protected boolean updateAuthentication()

Return true if we're successful in collecting new information (and thus the caller should try the request again). Subclasses can override to (e.g.) collect updated authentication information by prompting the user. The implementation in this class returns false, indicating that the authentication information was not updated.

refetchInvalidModel

protected boolean refetchInvalidModel()

If admin model is invalid, will be automatically refetched?

getFromEnvironment

protected String getFromEnvironment(String name)

Subclasses can override to supply parameter values from environment. The implementation in this class returns null, indicating that the name is not available in the environment.

retryUsingSecureConnection

protected boolean retryUsingSecureConnection(String host,
                                 int port)

Called when a non-secure connection attempt fails and it appears that the server requires a secure connection. Subclasses can override to indicate that the connection should The implementation in this class returns false, indicating that the connection should not be retried.

reportAuthenticationException

protected String reportAuthenticationException()

Return the error message to be used in the AuthenticationException. Subclasses can override to provide a more detailed message, for example, indicating the source of the password that failed. The implementation in this class returns a default error message.

getSslContext

protected SSLContext getSslContext()

createStandardSslContext

protected static SSLContext createStandardSslContext(boolean interactive)

addAdditionalHeaders

protected javax.ws.rs.client.Invocation.Builder addAdditionalHeaders(javax.ws.rs.client.Invocation.Builder request)

Adds any headers needed for the current environment to the admin request.

Parameters:

request -

processHeaders

protected void processHeaders(javax.ws.rs.core.Response headers)

Process any headers needed from the reply to the admin request. Subclasses can override this method to handle processing headers in the command's reply.

authenticationInfo

protected AuthenticationInfo authenticationInfo()

getUsage

public String getUsage()

Get the usage text. If we got usage information from the server, use it.

Returns:

usage text

getManPage

public String getManPage()
                  throws org.glassfish.api.admin.CommandException

Throws:

org.glassfish.api.admin.CommandException

fetchCommandModel

protected void fetchCommandModel()
                          throws org.glassfish.api.admin.CommandException

Throws:

org.glassfish.api.admin.CommandException

getCanonicalHost

protected String getCanonicalHost()

preinit

public static void preinit()

CLI can use this method to inicialise internal structures of used services like jersey and ssl in parallel with other logic