org.apache.avalon.merlin
Interface KernelCriteria

All Superinterfaces:
Map
All Known Implementing Classes:
DefaultCriteria

public interface KernelCriteria
extends Map

A service that provides access to versioned resources.

Version:
$Revision: 1.1 $ $Date: 2003/12/08 15:37:12 $
Author:
Stephen McConnell

Nested Class Summary
 
Nested classes inherited from class java.util.Map
Map.Entry
 
Field Summary
static String MERLIN_ANCHOR
          Anchor directory for extension and classpath relative references.
static String MERLIN_AUTOSTART
          Auto start mode.
static String MERLIN_CONFIG
          Overide directives.
static String MERLIN_CONTEXT
          Base directory parameter.
static String MERLIN_DEBUG
          Debug policy parameter.
static String MERLIN_DEPLOYMENT
          A comma seperated sequence of block urls.
static String MERLIN_DIR
          Maerlin working directory.
static String MERLIN_HOME
          Merlin system home.
static String MERLIN_INFO
          Info policy parameter.
static String MERLIN_INSTALL
          Install directive path sequence.
static String MERLIN_KERNEL
          Merlin kernel url key.
static String MERLIN_LANG
          Language override.
static String MERLIN_OVERRIDE
          Merlin target configuration override path.
static String MERLIN_REPOSITORY
          Shared application repository root directory.
static String MERLIN_SERVER
          Server model parameter.
static String MERLIN_SYSTEM
          Merlin system repository cache path.
static String MERLIN_TEMP
          The temp directory parameter.
 
Method Summary
 File getAnchorDirectory()
          Return the anchor directory to be used when resolving library declarations in classload specifications.
 File getConfigDirectory()
          Return the root directory to the merlin configurations
 File getContextDirectory()
          Return the context directory from which relative runtrime home directories will be established for components referencing urn:avalon:home
 URL[] getDeploymentURLs()
          Return the set of block URLs to be included in the root application
 File getHomeDirectory()
          Return the root directory to the merlin installation
 URL getKernelURL()
          Return the url to the kernel confiuration
 String getLanguageCode()
          Return the lang code.
 String getOverridePath()
          Return the url to the configuration override targets.
 File getRepositoryDirectory()
          Return the root directory to the shared repository.
 File getSystemDirectory()
          Return the root directory to the merlin system repository
 File getTempDirectory()
          Return the temporary client directory.
 File getWorkingDirectory()
          Return the working client directory.
 boolean isAutostartEnabled()
          Return the autostart policy.
 boolean isDebugEnabled()
          Return debug policy.
 boolean isInfoEnabled()
          Return info generation policy.
 boolean isServerEnabled()
          Return server execution policy.
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Field Detail

MERLIN_REPOSITORY

public static final String MERLIN_REPOSITORY
Shared application repository root directory.

See Also:
Constant Field Values

MERLIN_HOME

public static final String MERLIN_HOME
Merlin system home.

See Also:
Constant Field Values

MERLIN_SYSTEM

public static final String MERLIN_SYSTEM
Merlin system repository cache path.

See Also:
Constant Field Values

MERLIN_CONFIG

public static final String MERLIN_CONFIG
Overide directives.

See Also:
Constant Field Values

MERLIN_INSTALL

public static final String MERLIN_INSTALL
Install directive path sequence.

See Also:
Constant Field Values

MERLIN_DEPLOYMENT

public static final String MERLIN_DEPLOYMENT
A comma seperated sequence of block urls.

See Also:
Constant Field Values

MERLIN_KERNEL

public static final String MERLIN_KERNEL
Merlin kernel url key.

See Also:
Constant Field Values

MERLIN_OVERRIDE

public static final String MERLIN_OVERRIDE
Merlin target configuration override path.

See Also:
Constant Field Values

MERLIN_DIR

public static final String MERLIN_DIR
Maerlin working directory.

See Also:
Constant Field Values

MERLIN_TEMP

public static final String MERLIN_TEMP
The temp directory parameter.

See Also:
Constant Field Values

MERLIN_CONTEXT

public static final String MERLIN_CONTEXT
Base directory parameter.

See Also:
Constant Field Values

MERLIN_ANCHOR

public static final String MERLIN_ANCHOR
Anchor directory for extension and classpath relative references.

See Also:
Constant Field Values

MERLIN_INFO

public static final String MERLIN_INFO
Info policy parameter.

See Also:
Constant Field Values

MERLIN_DEBUG

public static final String MERLIN_DEBUG
Debug policy parameter.

See Also:
Constant Field Values

MERLIN_SERVER

public static final String MERLIN_SERVER
Server model parameter.

See Also:
Constant Field Values

MERLIN_AUTOSTART

public static final String MERLIN_AUTOSTART
Auto start mode.

See Also:
Constant Field Values

MERLIN_LANG

public static final String MERLIN_LANG
Language override.

See Also:
Constant Field Values
Method Detail

getLanguageCode

public String getLanguageCode()
Return the lang code. A null value indicates that the default language applies.

Returns:
the language code

getRepositoryDirectory

public File getRepositoryDirectory()
Return the root directory to the shared repository.

Returns:
the root common repository directory

getHomeDirectory

public File getHomeDirectory()
Return the root directory to the merlin installation

Returns:
the merlin home directory

getSystemDirectory

public File getSystemDirectory()
Return the root directory to the merlin system repository

Returns:
the merlin system repository directory

getDeploymentURLs

public URL[] getDeploymentURLs()
Return the set of block URLs to be included in the root application

Returns:
the block deployment urls

getConfigDirectory

public File getConfigDirectory()
Return the root directory to the merlin configurations

Returns:
the merlin configuration directory

getKernelURL

public URL getKernelURL()
Return the url to the kernel confiuration

Returns:
the kernel configuration url

getOverridePath

public String getOverridePath()
Return the url to the configuration override targets.

Returns:
the override url

getWorkingDirectory

public File getWorkingDirectory()
Return the working client directory.

Returns:
the working directory

getTempDirectory

public File getTempDirectory()
Return the temporary client directory.

Returns:
the temp directory

getContextDirectory

public File getContextDirectory()
Return the context directory from which relative runtrime home directories will be established for components referencing urn:avalon:home

Returns:
the working directory

getAnchorDirectory

public File getAnchorDirectory()
Return the anchor directory to be used when resolving library declarations in classload specifications.

Returns:
the anchor directory

isInfoEnabled

public boolean isInfoEnabled()
Return info generation policy. If TRUE the parameters related to deployment will be listed on startup.

Returns:
the info policy

isDebugEnabled

public boolean isDebugEnabled()
Return debug policy. If TRUE all logging channels will be set to debug level (useful for debugging).

Returns:
the debug policy

isServerEnabled

public boolean isServerEnabled()
Return server execution policy. If TRUE the kernel will continue until explicitly terminated. If FALSE the kernel will initiate decommissioning on completion of deployment.

Returns:
the server execution mode

isAutostartEnabled

public boolean isAutostartEnabled()
Return the autostart policy. If TRUE (the default) the deployment of the application container will be initiated following kernel initialization.

Returns:
the autostart policy


Copyright © Apache Software Foundation. All Rights Reserved.