oracle.adf.model.adapter.rest

Class RestURLDataControl

java.lang.Object

oracle.adf.model.adapter.AbstractImpl

oracle.adf.model.adapter.rest.RestURLDataControl

All Implemented Interfaces:

DataControl, DefinitionProviderDataControl, UpdateableDataControl

public class RestURLDataControl
extends AbstractImpl
implements UpdateableDataControl, DefinitionProviderDataControl

Since:

release specific (what release of product did this appear in)

Field Summary

Fields inherited from class oracle.adf.model.adapter.AbstractImpl

METHOD_CREATE, METHOD_EXECUTE, mName, SORT_CRITERIA

Constructor Summary

Constructors

Constructor and Description
RestURLDataControl()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	createRowData(RowContext ctx) This method is called by the data binding framework when a new row is needed from the data control.
java.lang.Object	getDataProvider() Returns the Business Service Object that this datacontrol is associated with.
Definition	getDefinition(java.lang.String name, int type) Returns a definition of the specified type.
java.util.Map<java.lang.String,java.lang.String>	getDynamicQueryParams()
java.lang.String	getHttpErrorResponse() Returns the error response of the server if the last call to invokeOperation fetched a HTTP Response with HTTP Status code >300 and if HTTP Header Content-Type is of media type application/json, text/plain or application/xml (or an extension of xml e.g application/rss+xml) The error response from last invoked operation is cleared, once another call to invokeOperation is made.
java.lang.String	getName() Returns name to identify this datacontrol inside a BindingContext.
java.util.Map<java.lang.String,java.lang.String>	getRequestHTTPHeaders() The method do not clone and return the header maps.
java.util.Map<java.lang.String,java.util.List<java.lang.Object>>	getResponseHTTPHeaders() Returns the Response HTTP Header from the HTTP call made by invokeOperation The headers e from last invoked operation is cleared, once another call to invokeOperation is made.
int	getStatusCode() Give the status code for last HTTP request.
boolean	invokeOperation(java.util.Map bindingContext, OperationBinding action) All OperationBindings should first delegate to the DataControl associated with the binding to perform the action.
java.lang.Object	registerDataProvider(RowContext ctx) This method is called by the data binding facility before the row in the RowContext object is modified or marked as removed, so the row can be marked dirty by the data control.
void	release() Releases the DataControl.
boolean	removeRowData(RowContext ctx) This method is called by the data binding facility when a row should be removed from the underlying data source.
boolean	setAttributeValue(AttributeContext ctx, java.lang.Object value) This method is called by the data binding framework when a new value is to be set on an attribute in a bean.
void	setDynamicQueryParams(java.util.Map<java.lang.String,java.lang.String> dynamicQueryParams) Sets the Query Parameter to the http requests made for this data control Instance
void	setRequestHTTPHeaders(java.util.Map<java.lang.String,java.lang.String> requestHttpHeaderParams) Meant for groovy invocation.
void	validate() Validates transaction if dirty.

Methods inherited from class oracle.adf.model.adapter.AbstractImpl

addParameter, createAndAddNewRow, createEmptyDataSet, findContainedDef, getAdapterContext, getDefinition, getDefinitionInternal, getParameterNames, getParameterValue, getSortCriteria, getStructureDef, getStructureDef, processResult, removeCurrentRow, setDefinition, setName, setParameterValue, setStructureDef, shouldReexecuteOperation

Methods inherited from class java.lang.Object

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

Constructor Detail

RestURLDataControl

public RestURLDataControl()

Method Detail

setDynamicQueryParams

public void setDynamicQueryParams(java.util.Map<java.lang.String,java.lang.String> dynamicQueryParams)

Sets the Query Parameter to the http requests made for this data control Instance

Parameters:

dynamicQueryParams -

getHttpErrorResponse

public java.lang.String getHttpErrorResponse()

Returns the error response of the server if the last call to invokeOperation fetched a HTTP Response with HTTP Status code >300 and if HTTP Header Content-Type is of media type application/json, text/plain or application/xml (or an extension of xml e.g application/rss+xml) The error response from last invoked operation is cleared, once another call to invokeOperation is made.

Returns:

the error Response

getStatusCode

public int getStatusCode()

Give the status code for last HTTP request. These are grouped as follows:

• 1xx - Informational (as per HTTP/1.1)
• 2xx - Success
• 3xx - Redirection
• 4xx - Client Error
• 5xx - Server Error
• -1 No reference to last HTTP request is available.

Returns:

getResponseHTTPHeaders

public java.util.Map<java.lang.String,java.util.List<java.lang.Object>> getResponseHTTPHeaders()

Returns the Response HTTP Header from the HTTP call made by invokeOperation The headers e from last invoked operation is cleared, once another call to invokeOperation is made.

Returns:

setRequestHTTPHeaders

public void setRequestHTTPHeaders(java.util.Map<java.lang.String,java.lang.String> requestHttpHeaderParams)

Meant for groovy invocation. Usage : def dc = adf.webServices.dcID; dc.requestHTTPHeaders = ['key','value'];

getRequestHTTPHeaders

public java.util.Map<java.lang.String,java.lang.String> getRequestHTTPHeaders()

The method do not clone and return the header maps. Caller should be aware that any modification to map will be reflected in HTTP call later

Returns:

getDynamicQueryParams

public java.util.Map<java.lang.String,java.lang.String> getDynamicQueryParams()

invokeOperation

public boolean invokeOperation(java.util.Map bindingContext,
                               OperationBinding action)

Description copied from interface: DataControl

All OperationBindings should first delegate to the DataControl associated with the binding to perform the action. DataControls may choose to interpret a given action differently based on the data/collection that action is bound to.

Specified by:

invokeOperation in interface DataControl

Returns:

true if this datacontrol has handled this action, false if the action should be interpreted in the bindings framework or in the caller.

createRowData

public java.lang.Object createRowData(RowContext ctx)

Description copied from interface: UpdateableDataControl

This method is called by the data binding framework when a new row is needed from the data control.

Specified by:

createRowData in interface UpdateableDataControl

Parameters:

ctx - Context of the new row.

Returns:

A data object for the new row.

getDataProvider

public java.lang.Object getDataProvider()

Description copied from interface: DataControl

Returns the Business Service Object that this datacontrol is associated with.

Specified by:

getDataProvider in interface DataControl

Returns:

The underlying business service object.

getDefinition

public Definition getDefinition(java.lang.String name,
                                int type)

Description copied from interface: DefinitionProviderDataControl

Returns a definition of the specified type.

Specified by:

getDefinition in interface DefinitionProviderDataControl

getName

public java.lang.String getName()

Description copied from interface: DataControl

Returns name to identify this datacontrol inside a BindingContext.

Specified by:

getName in interface DataControl

registerDataProvider

public java.lang.Object registerDataProvider(RowContext ctx)

Description copied from interface: UpdateableDataControl

This method is called by the data binding facility before the row in the RowContext object is modified or marked as removed, so the row can be marked dirty by the data control.

Specified by:

registerDataProvider in interface UpdateableDataControl

Parameters:

ctx - Context of the row to be modified or removed.

Returns:

The data object that the row represents.

release

public void release()

Description copied from interface: DataControl

Releases the DataControl. The DataControl should be in a collectable state after release() has been invokd.

This should close all open DataControl resources.

Specified by:

release in interface DataControl

removeRowData

public boolean removeRowData(RowContext ctx)

Description copied from interface: UpdateableDataControl

This method is called by the data binding facility when a row should be removed from the underlying data source.

Specified by:

removeRowData in interface UpdateableDataControl

Parameters:

ctx - Context of the row to be removed.

Returns:

true if the operation is sucessful, false otherwise.

setAttributeValue

public boolean setAttributeValue(AttributeContext ctx,
                                 java.lang.Object value)

Description copied from interface: UpdateableDataControl

This method is called by the data binding framework when a new value is to be set on an attribute in a bean. The attribute and bean are provided in the attribute context along with other framework context information.

Return true if the base framework should skip any further processing of this attribute set. Otherwise return false so that framework can perform a set or put of the attribute value based on introspection.

Specified by:

setAttributeValue in interface UpdateableDataControl

validate

public void validate()

Description copied from interface: UpdateableDataControl

Validates transaction if dirty.

Specified by:

validate in interface UpdateableDataControl