oracle.adfinternal.model.adapter

Class ChildOperation

java.lang.Object

oracle.adfinternal.model.adapter.ChildOperation

public abstract class ChildOperation
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONNECTION_NAME Attribute to hold the connection name.
static java.lang.String	DEFINITION Definition tag as the root.
static java.lang.String	ENSURE_KEY_ATTRIBUTE
static java.lang.String	HTTP_HEADERS HttpHeaders Element, describes the custom Http Headers.
static java.lang.String	HTTP_METHOD Attribute to hold the HTTP Method.
static java.lang.String	ID Attribute to hold the ID.
static java.lang.String	IMPL_DEF Attribute to hold the ImplDef.
static java.lang.String	INPUT_SCHEMA_LOC Attribute to contain the input XSD URL
protected java.lang.String	mConnectionName
protected boolean	mEnsureKeyAttribute
static java.lang.String	METHOD_REF Attribute to hold media type for Rest Datacontrol child operation.
static java.lang.String	METHOD_REF_DESCRIBE
static java.lang.String	METHOD_REF_JSON
static java.lang.String	METHOD_REF_WADL
static java.lang.String	METHOD_REF_XSD
protected java.lang.String	mHttpHeaderParamName
protected java.lang.String	mHttpMethod
protected java.lang.String	mID
protected boolean	mIncludeHttpHeaders
protected java.lang.String	mInputSchemaLoc
protected oracle.adf.share.logging.ADFLogger	mLogger
protected java.lang.String	mRootElement
protected java.lang.String	mSchemaLoc Holds the schema location.
protected java.lang.String	mUrlQuery
protected java.lang.String	mXSLLoc
static java.lang.String	PARAM_NAME HttpHeaders ParamName attribute
static java.lang.String	PARAMETER Parameter tag
static java.lang.String	PARAMETER_NAME Parameter name tag
static java.lang.String	PARAMETER_VALUE Parameter Value tag
static java.lang.String	PARAMETERS Parameters tag
static java.lang.String	SCHEMA_LOC Attribute to contain the XSD URL.
static java.lang.String	SOURCE_LOC Attribute to contain the source URL.
static java.lang.String	TRANSFORMER_LOC Attribute to contain the XSL URL.
static java.lang.String	URL_QUERY Attribute to hold the URL query.
static java.lang.String	USE_PERSIST_STRUCT
static java.lang.String	XML_ROOT_ELEMENT Attribute to hold root element

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChildOperation(java.lang.String xmlns)
protected	ChildOperation(java.lang.String xmlns, java.lang.String implDef)

Method Summary

Methods

Modifier and Type	Method and Description
protected java.io.InputStream	callGetLocationStream(AdapterContext adapterCtx, java.lang.String loc)
static ChildOperation	createJSONMediaChildOperation(java.lang.String xmlns)
static ChildOperation	createJSONMediaChildOperation(java.lang.String xmlns, java.lang.String implDef)
static ChildOperation	createMLMediaChildOperation(java.lang.String xmlns) Deprecated.
static ChildOperation	createMLMediaChildOperation(java.lang.String xmlns, java.lang.String implDef) Deprecated.
static ChildOperation	createXMLMediaChildOperation(java.lang.String xmlns)
static ChildOperation	createXMLMediaChildOperation(java.lang.String xmlns, java.lang.String implDef)
protected abstract byte[]	fetchBodyStream(java.lang.Object pName, java.util.Map params)
protected abstract java.lang.String	getAcceptheader()
protected AuthenticationScheme	getAuthenticationScheme(AdapterContext adapterCtx) Returns the authenticationscheme from the connection.
java.lang.String	getConnectionName() return the URL connection name.
protected abstract java.lang.String	getContentTypeHeader()
protected boolean	getEnsureStructureV2()
protected java.lang.Object	getHttpComplexParamName(java.util.Map params)
java.lang.String	getHttpHeaderParamName()
java.lang.String	getHttpMethod() return the Http Method.
protected HTTPClient.HTTPResponse	getHTTPResponse(HTTPClient.HTTPConnection httpInteraction, java.lang.String pathAndQuery, java.util.Map params, java.util.Map httpHeadersParam, java.lang.String httpMethod)
java.lang.String	getID()
java.lang.String	getInputXSDLoc() return the Input XSD Location.
protected com.sun.jersey.api.client.ClientResponse	getJerseyResponse(com.sun.jersey.api.client.WebResource resource, java.util.Map params, java.util.Map httpHeadersParam, java.lang.String httpMethod)
Node	getMetadata(AdapterContext adapterContext, java.lang.String name)
MethodDef	getMethodDef(StructureDef structDef, AdapterContext adapterCtx, java.lang.String dcName)
protected abstract MethodDef	getMethodDefInternal(StructureDef structDef, AdapterContext adapterCtx, java.lang.String dcName) Must be overridden by the child class.
java.util.Map	getParamsMap() Returns a mapping of the parameters and the default values.
java.lang.String	getRootElement()
java.lang.String	getSourceLocation() return the data source location.
java.lang.String	getUrlQuery() return the Url query.
java.lang.String	getXSDLocation() return the XSD location.
protected java.io.InputStream	getXSDStream(AdapterContext adapterCtx)
java.lang.String	getXSLLocation()
protected void	initXSDHandler()
java.lang.Object	invokeOperation(OperationBinding action, AdapterContext adapterCtx)
protected abstract java.lang.Object	invokeOperationInternal(java.util.Map params, AdapterContext adapterCtx)
boolean	isIncludeHttpHeaders()
protected static boolean	isNotEmptyOrNull(java.lang.String value)
void	loadDefinition(Node node, java.util.Map params)
protected abstract void	prepareMetadataInternal(AdapterContext adapterContext, java.lang.String name, java.util.Map paramsMap)
void	setCachingMode(int cachingMode)
protected abstract void	setChildMediaType(Element metadata)
void	setConnectionName(java.lang.String connName)
void	setEnsureKeyAttribute(boolean ensureKeyAttribute) Deprecated.
void	setEnsureStructureV2(boolean ensureStructureV2) Deprecated.
void	setHttpHeaderParamName(java.lang.String mHttpHeaderParamName)
void	setHttpMethod(java.lang.String methodName) Sets the Http Method for the definition.
void	setID(java.lang.String id)
void	setIncludeHttpHeaders(boolean mIncludeHttpHeaders)
void	setInputXSDLoc(java.lang.String XSDLoc) Sets the Input XSD Location.
void	setParamsMap(java.util.Map paramsMap) Sets the parameter Maps for the definition.
void	setRootElement(java.lang.String rootElement) set the RootElement.
void	setSourceLocation(java.lang.String loc)
void	setUrlQuery(java.lang.String query)
void	setXSDLocation(java.lang.String xsdLoc) set the XSD location.
void	setXSLLocation(java.lang.String xslLoc) set the XSL location.

Methods inherited from class java.lang.Object

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

Field Detail

DEFINITION

public static final java.lang.String DEFINITION

Definition tag as the root.

See Also:

Constant Field Values

SOURCE_LOC

public static final java.lang.String SOURCE_LOC

Attribute to contain the source URL.

See Also:

Constant Field Values

CONNECTION_NAME

public static final java.lang.String CONNECTION_NAME

Attribute to hold the connection name.

See Also:

Constant Field Values

URL_QUERY

public static final java.lang.String URL_QUERY

Attribute to hold the URL query.

See Also:

Constant Field Values

HTTP_METHOD

public static final java.lang.String HTTP_METHOD

Attribute to hold the HTTP Method.

See Also:

Constant Field Values

ID

public static final java.lang.String ID

Attribute to hold the ID.

See Also:

Constant Field Values

IMPL_DEF

public static final java.lang.String IMPL_DEF

Attribute to hold the ImplDef.

See Also:

Constant Field Values

METHOD_REF

public static final java.lang.String METHOD_REF

Attribute to hold media type for Rest Datacontrol child operation.

See Also:

Constant Field Values

METHOD_REF_XSD

public static final java.lang.String METHOD_REF_XSD

See Also:

Constant Field Values

METHOD_REF_JSON

public static final java.lang.String METHOD_REF_JSON

See Also:

Constant Field Values

METHOD_REF_DESCRIBE

public static final java.lang.String METHOD_REF_DESCRIBE

See Also:

Constant Field Values

METHOD_REF_WADL

public static final java.lang.String METHOD_REF_WADL

See Also:

Constant Field Values

SCHEMA_LOC

public static final java.lang.String SCHEMA_LOC

Attribute to contain the XSD URL.

See Also:

Constant Field Values

TRANSFORMER_LOC

public static final java.lang.String TRANSFORMER_LOC

Attribute to contain the XSL URL.

See Also:

Constant Field Values

USE_PERSIST_STRUCT

public static final java.lang.String USE_PERSIST_STRUCT

See Also:

Constant Field Values

INPUT_SCHEMA_LOC

public static final java.lang.String INPUT_SCHEMA_LOC

Attribute to contain the input XSD URL

See Also:

Constant Field Values

XML_ROOT_ELEMENT

public static final java.lang.String XML_ROOT_ELEMENT

Attribute to hold root element

See Also:

Constant Field Values

PARAMETERS

public static final java.lang.String PARAMETERS

Parameters tag

See Also:

Constant Field Values

PARAMETER

public static final java.lang.String PARAMETER

Parameter tag

See Also:

Constant Field Values

PARAMETER_NAME

public static final java.lang.String PARAMETER_NAME

Parameter name tag

See Also:

Constant Field Values

PARAMETER_VALUE

public static final java.lang.String PARAMETER_VALUE

Parameter Value tag

See Also:

Constant Field Values

HTTP_HEADERS

public static final java.lang.String HTTP_HEADERS

HttpHeaders Element, describes the custom Http Headers.

See Also:

Constant Field Values

PARAM_NAME

public static final java.lang.String PARAM_NAME

HttpHeaders ParamName attribute

See Also:

Constant Field Values

ENSURE_KEY_ATTRIBUTE

public static final java.lang.String ENSURE_KEY_ATTRIBUTE

See Also:

Constant Field Values

mConnectionName

protected java.lang.String mConnectionName

mUrlQuery

protected java.lang.String mUrlQuery

mHttpMethod

protected java.lang.String mHttpMethod

mID

protected java.lang.String mID

mSchemaLoc

protected java.lang.String mSchemaLoc

Holds the schema location. In case of XML Media type, this holds location to a XSD schema, for JSON Media type this holds location to a JSON Schema.

mXSLLoc

protected java.lang.String mXSLLoc

mInputSchemaLoc

protected java.lang.String mInputSchemaLoc

mRootElement

protected java.lang.String mRootElement

mIncludeHttpHeaders

protected boolean mIncludeHttpHeaders

mHttpHeaderParamName

protected java.lang.String mHttpHeaderParamName

mEnsureKeyAttribute

protected boolean mEnsureKeyAttribute

mLogger

protected oracle.adf.share.logging.ADFLogger mLogger

Constructor Detail

ChildOperation

protected ChildOperation(java.lang.String xmlns)

ChildOperation

protected ChildOperation(java.lang.String xmlns,
              java.lang.String implDef)

Method Detail

createXMLMediaChildOperation

public static ChildOperation createXMLMediaChildOperation(java.lang.String xmlns)

createXMLMediaChildOperation

public static ChildOperation createXMLMediaChildOperation(java.lang.String xmlns,
                                          java.lang.String implDef)

createJSONMediaChildOperation

public static ChildOperation createJSONMediaChildOperation(java.lang.String xmlns)

createJSONMediaChildOperation

public static ChildOperation createJSONMediaChildOperation(java.lang.String xmlns,
                                           java.lang.String implDef)

createMLMediaChildOperation

@Deprecated
public static ChildOperation createMLMediaChildOperation(java.lang.String xmlns)

Deprecated.

createMLMediaChildOperation

@Deprecated
public static ChildOperation createMLMediaChildOperation(java.lang.String xmlns,
                                                    java.lang.String implDef)

Deprecated.

getMetadata

public Node getMetadata(AdapterContext adapterContext,
               java.lang.String name)

loadDefinition

public void loadDefinition(Node node,
                  java.util.Map params)

getMethodDef

public MethodDef getMethodDef(StructureDef structDef,
                     AdapterContext adapterCtx,
                     java.lang.String dcName)

invokeOperation

public java.lang.Object invokeOperation(OperationBinding action,
                               AdapterContext adapterCtx)

initXSDHandler

protected void initXSDHandler()

invokeOperationInternal

protected abstract java.lang.Object invokeOperationInternal(java.util.Map params,
                                       AdapterContext adapterCtx)

setID

public void setID(java.lang.String id)

setSourceLocation

public void setSourceLocation(java.lang.String loc)

getSourceLocation

public java.lang.String getSourceLocation()

return the data source location.

setUrlQuery

public void setUrlQuery(java.lang.String query)

setXSLLocation

public void setXSLLocation(java.lang.String xslLoc)

set the XSL location.

getXSLLocation

public java.lang.String getXSLLocation()

setRootElement

public void setRootElement(java.lang.String rootElement)

set the RootElement.

getRootElement

public java.lang.String getRootElement()

setParamsMap

public void setParamsMap(java.util.Map paramsMap)

Sets the parameter Maps for the definition. The parameter name,value will be used to define the structure of the data.

getParamsMap

public java.util.Map getParamsMap()

Returns a mapping of the parameters and the default values. The parameters can be URI or PATH parameters as in http://somewhere.com?a=##param1## or http://foo.baa.com/index/##Myfile## In the examples shown both param1 and MyFile are the parameters to the data control method.

Returns:

the Map of the name value String pairs of the parameters.

setIncludeHttpHeaders

public void setIncludeHttpHeaders(boolean mIncludeHttpHeaders)

isIncludeHttpHeaders

public boolean isIncludeHttpHeaders()

setHttpHeaderParamName

public void setHttpHeaderParamName(java.lang.String mHttpHeaderParamName)

getHttpHeaderParamName

public java.lang.String getHttpHeaderParamName()

setEnsureKeyAttribute

@Deprecated
public void setEnsureKeyAttribute(boolean ensureKeyAttribute)

Deprecated.

setEnsureStructureV2

@Deprecated
public void setEnsureStructureV2(boolean ensureStructureV2)

Deprecated.

getEnsureStructureV2

protected boolean getEnsureStructureV2()

getConnectionName

public java.lang.String getConnectionName()

return the URL connection name.

getUrlQuery

public java.lang.String getUrlQuery()

return the Url query.

getHttpMethod

public java.lang.String getHttpMethod()

return the Http Method.

setHttpMethod

public void setHttpMethod(java.lang.String methodName)

Sets the Http Method for the definition.

Parameters:

methodName - Http Method to be invoked

getHttpComplexParamName

protected java.lang.Object getHttpComplexParamName(java.util.Map params)

getXSDStream

protected java.io.InputStream getXSDStream(AdapterContext adapterCtx)

getID

public java.lang.String getID()

setConnectionName

public void setConnectionName(java.lang.String connName)

setXSDLocation

public void setXSDLocation(java.lang.String xsdLoc)

set the XSD location.

getXSDLocation

public java.lang.String getXSDLocation()

return the XSD location.

setInputXSDLoc

public void setInputXSDLoc(java.lang.String XSDLoc)

Sets the Input XSD Location.

Parameters:

XSDLoc - Input XSD URL

getInputXSDLoc

public java.lang.String getInputXSDLoc()

return the Input XSD Location.

setCachingMode

public void setCachingMode(int cachingMode)

getAuthenticationScheme

protected AuthenticationScheme getAuthenticationScheme(AdapterContext adapterCtx)

Returns the authenticationscheme from the connection. Returns null if the connection is not a secured connection.

Returns:

callGetLocationStream

protected java.io.InputStream callGetLocationStream(AdapterContext adapterCtx,
                                        java.lang.String loc)

isNotEmptyOrNull

protected static boolean isNotEmptyOrNull(java.lang.String value)

getJerseyResponse

protected com.sun.jersey.api.client.ClientResponse getJerseyResponse(com.sun.jersey.api.client.WebResource resource,
                                                         java.util.Map params,
                                                         java.util.Map httpHeadersParam,
                                                         java.lang.String httpMethod)
                                                              throws java.lang.Exception

Throws:

java.lang.Exception

getHTTPResponse

protected HTTPClient.HTTPResponse getHTTPResponse(HTTPClient.HTTPConnection httpInteraction,
                                      java.lang.String pathAndQuery,
                                      java.util.Map params,
                                      java.util.Map httpHeadersParam,
                                      java.lang.String httpMethod)

fetchBodyStream

protected abstract byte[] fetchBodyStream(java.lang.Object pName,
                     java.util.Map params)
                                   throws java.io.IOException

Throws:

java.io.IOException

getAcceptheader

protected abstract java.lang.String getAcceptheader()

getContentTypeHeader

protected abstract java.lang.String getContentTypeHeader()

getMethodDefInternal

protected abstract MethodDef getMethodDefInternal(StructureDef structDef,
                             AdapterContext adapterCtx,
                             java.lang.String dcName)

Must be overridden by the child class.

Parameters:

structDef -

adapterCtx -

dcName -

Returns:

prepareMetadataInternal

protected abstract void prepareMetadataInternal(AdapterContext adapterContext,
                           java.lang.String name,
                           java.util.Map paramsMap)

setChildMediaType

protected abstract void setChildMediaType(Element metadata)