net.dpml.station.info
Class ApplicationDescriptor

java.lang.Object
  net.dpml.lang.AbstractDirective
      net.dpml.transit.info.CodeBaseDirective
          net.dpml.station.info.ApplicationDescriptor

All Implemented Interfaces:

Serializable

public class ApplicationDescriptor
extends CodeBaseDirective

The ApplicationDescriptor is immutable datastructure used to describe an application.

Version:

1.2.0

Author:

Digital Product Meta Library

See Also:

Serialized Form

Field Summary

static int	DEFAULT_SHUTDOWN_TIMEOUT The default shutdown timeout in seconds.
static int	DEFAULT_STARTUP_TIMEOUT The default startup timeout in seconds.

Constructor Summary

ApplicationDescriptor(URI codebase, String title, ValueDirective[] parameters, String base, StartupPolicy policy, int startupTimeout, int shutdownTimeout, Properties properties, URI config)
Creation of a new codebase descriptor.

Method Summary

boolean	equals(Object other) Compare this object with another for equality.
String	getBasePath() Returns the path defining the basedir that the application will be deployed within.
URI	getConfigurationURI() Get the configuration uri.
String	getConfigurationURISpec() Get the configuration uri specification.
int	getShutdownTimeout() Get the duration in seconds to wait for the shutdown of the application before considering the process as non-responsive.
StartupPolicy	getStartupPolicy() Return the application startup policy.
int	getStartupTimeout() Get the duration in seconds to wait for startup of the application before considering deployment as a timeout failure.
Properties	getSystemProperties() Get the system properties.
String	getTitle() Returns the application title.
int	hashCode() Return the hashcode for the object.
String	toString() Return a string representation of the application descriptor.

Methods inherited from class net.dpml.transit.info.CodeBaseDirective

getCodeBaseURI, getCodeBaseURISpec, getValueDirectives

Methods inherited from class net.dpml.lang.AbstractDirective

equals, hashArray, hashValue

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_STARTUP_TIMEOUT

public static final int DEFAULT_STARTUP_TIMEOUT

The default startup timeout in seconds.

See Also:

Constant Field Values

DEFAULT_SHUTDOWN_TIMEOUT

public static final int DEFAULT_SHUTDOWN_TIMEOUT

The default shutdown timeout in seconds.

See Also:

Constant Field Values

Constructor Detail

ApplicationDescriptor

public ApplicationDescriptor(URI codebase,
                             String title,
                             ValueDirective[] parameters,
                             String base,
                             StartupPolicy policy,
                             int startupTimeout,
                             int shutdownTimeout,
                             Properties properties,
                             URI config)

Creation of a new codebase descriptor.

Parameters:

codebase - the codebase uri

title - the profile title

parameters - an array of plugin parameter descriptors

base - working directory path

policy - the application startup policy

startupTimeout - startup timeout value

shutdownTimeout - shutdown timeout value

properties - system properties

config - uri to a part configuration

Method Detail

getTitle

public String getTitle()

Returns the application title.

Returns:

the title

getBasePath

public String getBasePath()

Returns the path defining the basedir that the application will be deployed within.

Returns:

the bassedir path

getStartupPolicy

public StartupPolicy getStartupPolicy()

Return the application startup policy.

Returns:

the startup policy

getStartupTimeout

public int getStartupTimeout()

Get the duration in seconds to wait for startup of the application before considering deployment as a timeout failure.

Returns:

the startup timeout value

getShutdownTimeout

public int getShutdownTimeout()

Get the duration in seconds to wait for the shutdown of the application before considering the process as non-responsive.

Returns:

the shutdown timeout value

getSystemProperties

public Properties getSystemProperties()

Get the system properties.

Returns:

the system properties

getConfigurationURISpec

public String getConfigurationURISpec()

Get the configuration uri specification.

Returns:

the configuration uri spec

getConfigurationURI

public URI getConfigurationURI()

Get the configuration uri.

Returns:

the configuration uri

equals

public boolean equals(Object other)

Compare this object with another for equality.

Overrides:

equals in class CodeBaseDirective

Parameters:

other - the object to compare this object with

Returns:

TRUE if the supplied object equivalent

hashCode

public int hashCode()

Return the hashcode for the object.

Overrides:

hashCode in class CodeBaseDirective

Returns:

the hashcode value

toString

public String toString()

Return a string representation of the application descriptor.

Overrides:

toString in class Object

Returns:

the string value