oracle.adf.share

Class MetadataEnvironmentFactory

java.lang.Object

oracle.adf.share.MetadataEnvironmentFactory

Direct Known Subclasses:

DefaultMetadataEnvironmentFactory

public abstract class MetadataEnvironmentFactory
extends java.lang.Object

The factory of MetadataEnvironment instances.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTEXT_PARAMETER_PREFIX The prefix of the names of the context parameters: "adfmde-".

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetadataEnvironmentFactory() Constructs a factory.

Method Summary

Modifier and Type	Method and Description
static void	configureCurrentADFSessionOptions() Deprecated. Call AdfMetadataEnvironment.prepareDefaultMetadataContext() instead. This method will be removed from this class because it handles ADFSessionOptions objects which are specific to MDS repositories. Configures the current ADFSessionOptions object according to the current MetadataEnvironment object. Being "the current" means an object is returned by ADFContext.getCurrent().
protected void	configureCurrentADFSessionOptions(MetadataEnvironment env) Deprecated. New subclasses should not override this method. This method will be removed in the future because it handles ADFSessionOptions which are specific to MDS repositories. Configures the current ADFSessionOptions object for a given MetadataEnvironment object.
protected java.lang.String	getContextParameter(ADFContext context, java.lang.String name) Returns the value of a parameter of a context for this factory to create a new metadata environment.
static java.lang.String	getContextParameter(java.lang.String name) Returns the value of a parameter of the current context.
abstract boolean	isCustomMetadataEnvironment(MetadataEnvironment e) Returns true if the given instance is a custom instance.
static boolean	isUnified() Returns true if the current state of the system supports unified metadata environments.
abstract MetadataEnvironment	newInstance(java.util.Map<java.lang.String,java.lang.Object> config) Creates a new instance of MetadataEnvironment based on the current user context and the configuration.
protected boolean	supportsUnifiedEnvironments() Returns true if the metadata environments created by this factory are unified environments.

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT_PARAMETER_PREFIX

public static final java.lang.String CONTEXT_PARAMETER_PREFIX

The prefix of the names of the context parameters: "adfmde-".

See Also:

Constant Field Values

Constructor Detail

MetadataEnvironmentFactory

protected MetadataEnvironmentFactory()

Constructs a factory.

Method Detail

newInstance

public abstract MetadataEnvironment newInstance(java.util.Map<java.lang.String,java.lang.Object> config)

Creates a new instance of MetadataEnvironment based on the current user context and the configuration.

Parameters:

config - the configuration of the new instance; null if the default configuration should be used

Returns:

a new instance of MetadataEnvironment based on the current user context and the configuration if supplied

isCustomMetadataEnvironment

public abstract boolean isCustomMetadataEnvironment(MetadataEnvironment e)

Returns true if the given instance is a custom instance. A custom instance is an instance that is not created by this factory.

Parameters:

e - the instance to be checked

Returns:

true if the given instance is a custom instance

See Also:

newInstance(java.util.Map<java.lang.String, java.lang.Object>)

supportsUnifiedEnvironments

protected boolean supportsUnifiedEnvironments()

Returns true if the metadata environments created by this factory are unified environments.

A unified environment supports multiple repositories. A non-unified environment supports only one single MDS repository. By default this method returns true. The implementation may allow this method to return false in a system that is not ready to be transitioned into a unified environment but the new code is already in place.

Returns:

true if the metadata environment is unified; false otherwise

isUnified

public static boolean isUnified()

Returns true if the current state of the system supports unified metadata environments.

Returns:

true if the current state of the system supports unified metadata environments; false otherwise

configureCurrentADFSessionOptions

@Deprecated
protected void configureCurrentADFSessionOptions(MetadataEnvironment env)

Deprecated. New subclasses should not override this method. This method will be removed in the future because it handles ADFSessionOptions which are specific to MDS repositories. Configures the current ADFSessionOptions object for a given MetadataEnvironment object.

Parameters:

env - the MetadataEnvironment object according to which the current ADFSessionOptions should be configured

Throws:

java.lang.IllegalArgumentException - if the given argument is null

java.lang.UnsupportedOperationException - if this feature is unsupported

configureCurrentADFSessionOptions

@Deprecated
public static void configureCurrentADFSessionOptions()

Deprecated. Call AdfMetadataEnvironment.prepareDefaultMetadataContext() instead. This method will be removed from this class because it handles ADFSessionOptions objects which are specific to MDS repositories. Configures the current ADFSessionOptions object according to the current MetadataEnvironment object. Being "the current" means an object is returned by ADFContext.getCurrent().

Throws:

java.lang.UnsupportedOperationException - if this feature is unsupported

getContextParameter

protected java.lang.String getContextParameter(ADFContext context,
                                               java.lang.String name)

Returns the value of a parameter of a context for this factory to create a new metadata environment. If the context is initialized in a servlet environment for a servlet request, this method returns the first value of the request parameter with a name that ends with the given name.

Parameters:

context - the context for this factory to create a new metadata environment

name - the name of the parameter

Returns:

the value of the context parameter; null if the value is null or the parameter does not exist

Throws:

java.lang.UnsupportedOperationException - if this method is not supported

getContextParameter

public static java.lang.String getContextParameter(java.lang.String name)

Returns the value of a parameter of the current context. If the context is initialized in a servlet environment for a servlet request, this method returns the first value of the request parameter with a name that ends with the given name.

Parameters:

name - the name of the parameter

Returns:

the value of the context parameter; null if the value is null or the parameter does not exist

Throws:

java.lang.UnsupportedOperationException - if this method is not supported

See Also:

getContextParameter(ADFContext, String)