public class RestDCDefinition extends AbstractDefinition
Modifier and Type | Class and Description |
---|---|
static class |
RestDCDefinition.ParentMediaType |
static class |
RestDCDefinition.ServiceType |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
REST_NS
Namespace for the metadata definition.
|
CACHE_TO_SOURCEPATH, DONT_CACHE, mDCConfiguration, mFullName, mRootDefName
TYPE_ACCESSOR, TYPE_ATTRIBUTE, TYPE_CRITERIA, TYPE_CRITERIA_ITEM, TYPE_CRITERIA_OPERATOR, TYPE_CRITERIA_ROW, TYPE_DATACONTROL, TYPE_DEFINITION, TYPE_DEFINITIONCONTEXT, TYPE_NAMED, TYPE_OPERATION, TYPE_OPERATIONRETURN, TYPE_PARAMETER, TYPE_STRUCTURE, TYPE_VARIABLE
Constructor and Description |
---|
RestDCDefinition() |
RestDCDefinition(java.lang.String name) |
Modifier and Type | Method and Description |
---|---|
void |
addDescribeOperation(java.lang.String resourceName,
DescribeChildOperation def)
Used to add a describe based definition to the RestDCDefinition aggregate map.
|
void |
configureRestDCServiceType(RestDCDefinition.ServiceType type,
java.lang.String... resources) |
void |
configureRestDCServiceType(java.lang.String serviceURL,
boolean createConnection,
RestDCDefinition.ServiceType type,
java.lang.String... resources) |
DescribeChildOperation |
createAndAddDescribeOperation(java.lang.String resourceName) |
DescribeChildOperation |
createAndAddDescribeOperation(java.lang.String baseUrl,
java.lang.String resourceName,
boolean createConnection) |
void |
createAndAddDescribeOperations() |
void |
createAndAddDescribeOperations(boolean createConnection,
java.lang.String connectionURL) |
DataControl |
createDataControl()
Creates an instance of data control generated from the metadata definition.
|
java.lang.String |
getAdapterType()
Returns the type of the adapter.
|
java.util.Collection<DescribeChildOperation> |
getAllDescribeOperations() |
javax.naming.Context |
getConnectionContext() |
java.lang.String |
getDCName()
Returns the name of the data control.
|
java.lang.String |
getDescBaseUrl() |
java.lang.String |
getDescConnectionName() |
DescribeChildOperation |
getDescribeOperation(java.lang.String resourceName)
Returns a describe based definition for the given resource name.
|
java.lang.String |
getFactoryClassName()
Advanced internal placeholder method.
|
java.lang.String |
getJUDTDataControlName() |
org.w3c.dom.Node |
getMetadata()
Returns the element that defines the metadata for the data control.
|
RestDCDefinition.ParentMediaType |
getParentMediaType() |
RestDCDefinition.ServiceType |
getServiceType() |
StructureDefinition |
getStructure()
Gets the structure definition of the output data.
|
boolean |
isStructureDirty(boolean refresh)
Tells the framework whether the Data control structure is dirty and needs
to be refreshed on the palette.
|
boolean |
isUseSharedLayerConn() |
void |
loadFromMetadata(org.w3c.dom.Node node,
java.util.Map params)
Loads the definition from a metadata
Node . |
void |
setDescBaseUrl(java.lang.String descBaseUrl) |
void |
setDescConnectionName(java.lang.String descConnectionName) |
void |
setParentMediaType(RestDCDefinition.ParentMediaType parentMediaType) |
void |
setServiceType(RestDCDefinition.ServiceType serviceType) |
void |
setUseSharedLayerConn(boolean mUseSharedLayerConn) |
addParameter, assignDefaultPackage, createDuplicateDetailIterator, disableSharing, enableSharing, getAdapterContext, getCachingMode, getConfiguration, getConfigurationFullName, getDefClassName, getDefinitionParent, getDefinitionType, getFullName, getName, getParameter, getParameterCollection, getParameters, getProperties, getProperty, getRootStructureName, getRuntimeParameters, isSupported, removeParameter, setAdapterContext, setCachingMode, setCompileProjectOnCreate, setConfigurationFullName, setFullName, setName, setProperty, setRootStructureName, shouldCompileProjectOnCreate, useDefinitionProvider, usePersistedStructure
public static final java.lang.String REST_NS
public RestDCDefinition()
public RestDCDefinition(java.lang.String name)
public DataControl createDataControl()
AbstractDefinition
createDataControl
in class AbstractDefinition
public java.lang.String getAdapterType()
getAdapterType
in class AbstractDefinition
AdapterDefinition
public org.w3c.dom.Node getMetadata()
AbstractDefinition
getMetadata
in class AbstractDefinition
Node
that defines the metadata for this instance.
This metadata will be used at the runtime to fetch data from the
data source.public final javax.naming.Context getConnectionContext() throws java.lang.Exception
java.lang.Exception
public void loadFromMetadata(org.w3c.dom.Node node, java.util.Map params)
AbstractDefinition
Node
.loadFromMetadata
in class AbstractDefinition
node
- the metadata node. It can be null if no metadata is defined.params
- context parameters.public void configureRestDCServiceType(RestDCDefinition.ServiceType type, java.lang.String... resources)
public void configureRestDCServiceType(java.lang.String serviceURL, boolean createConnection, RestDCDefinition.ServiceType type, java.lang.String... resources)
public StructureDefinition getStructure()
AbstractDefinition
getStructure
in interface DataControlDefinition
getStructure
in class AbstractDefinition
@Concealed public void addDescribeOperation(java.lang.String resourceName, DescribeChildOperation def)
resourceName
- def
- public void setUseSharedLayerConn(boolean mUseSharedLayerConn)
public boolean isUseSharedLayerConn()
public DescribeChildOperation getDescribeOperation(java.lang.String resourceName)
resourceName
- public RestDCDefinition.ServiceType getServiceType()
public void setServiceType(RestDCDefinition.ServiceType serviceType)
@Concealed public java.util.Collection<DescribeChildOperation> getAllDescribeOperations()
public boolean isStructureDirty(boolean refresh)
isStructureDirty
in class AbstractDefinition
refresh
- flag to indicate if the refresh is requested for the
structure.public java.lang.String getDCName()
AbstractDefinition
getDCName
in class AbstractDefinition
public java.lang.String getFactoryClassName()
AbstractDefinition
getFactoryClassName
in class AbstractDefinition
@Concealed public java.lang.String getJUDTDataControlName()
getJUDTDataControlName
in class AbstractDefinition
@Concealed public RestDCDefinition.ParentMediaType getParentMediaType()
@Concealed public void setParentMediaType(RestDCDefinition.ParentMediaType parentMediaType)
public DescribeChildOperation createAndAddDescribeOperation(java.lang.String baseUrl, java.lang.String resourceName, boolean createConnection)
public DescribeChildOperation createAndAddDescribeOperation(java.lang.String resourceName)
public void createAndAddDescribeOperations(boolean createConnection, java.lang.String connectionURL)
public void createAndAddDescribeOperations()
public void setDescConnectionName(java.lang.String descConnectionName)
public java.lang.String getDescConnectionName()
public void setDescBaseUrl(java.lang.String descBaseUrl)
public java.lang.String getDescBaseUrl()