com.bea.wli.config.task.impl

Class GetEnvValueTask

java.lang.Object

com.bea.wli.config.task.impl.SessionedTask<java.lang.Object>

com.bea.wli.config.task.impl.GetEnvValueTask

All Implemented Interfaces:

java.util.concurrent.Callable<java.lang.Object>

public class GetEnvValueTask
extends SessionedTask<java.lang.Object>

Task to get a specific environment value

Constructor Summary

Constructors

Constructor and Description
GetEnvValueTask(Ref ref, java.lang.String envType, java.lang.String location) Constructor

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	_execute() Subclasses implement this method
static java.lang.Object	getEnvValue(ConfigService configService, java.lang.String session, Ref ref, java.lang.String envType, java.lang.String location) Convenience method to create and execute an instance of this task

Methods inherited from class com.bea.wli.config.task.impl.SessionedTask

assertExists, assertLocation, assertNONResource, assertNotExists, assertNotLocationData, assertNotNull, assertNotNullElement, assertResource, assertSimple, call, doExecute, doExecute, doExecute, doExecute, expand, getConfigContext, getConfigMBean, getConfigService, getDescription, getSession, isLocation, isReadOnlyTransaction, requiresSystemTransaction

Methods inherited from class java.lang.Object

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

Constructor Detail

GetEnvValueTask

public GetEnvValueTask(Ref ref,
                       java.lang.String envType,
                       java.lang.String location)

Constructor

Parameters:

ref - the resource to get the env value from

envType - the type of env value to get

location - the location of the env value within the resource

Method Detail

getEnvValue

public static java.lang.Object getEnvValue(ConfigService configService,
                                           java.lang.String session,
                                           Ref ref,
                                           java.lang.String envType,
                                           java.lang.String location)
                                    throws NotFoundException

Convenience method to create and execute an instance of this task

Parameters:

configService - the config service instance

session - the session to execute against; null indicates core

ref - the resource to get the env value from

envType - the type of env vslue to get

location - the location of the env value within the resourcd

Returns:

the env value

Throws:

NotFoundException - if the resource cannot be found

_execute

protected java.lang.Object _execute()
                             throws java.lang.Exception

Description copied from class: SessionedTask

Subclasses implement this method

Specified by:

_execute in class SessionedTask<java.lang.Object>

Returns:

the result of the execution

Throws:

java.lang.Exception