public interface AbstractXMLService extends Service
AbstractXMLService
represents CentraSite REST and XML services in CLL. They are a specialized
types of a Service
.Modifier and Type | Method and Description |
---|---|
boolean |
checkRouteToEndpoint()
Checks if a Virtual REST or Virtual XML Service requires modification of the Route-To
endpoint if a new resource is added to it.
|
java.lang.String |
fileAccessUrl(CentraSiteFile file)
Get the access URL for a file attached to the service.
|
void |
generateWSDL20()
(Re-)generate a WSDL20 file and update it to the service.
|
java.util.Map<java.lang.String,Category> |
getAllEndpointsWithSandbox()
Gets all the endpoints for the REST/XML service with the corresponding Sandbox category.
|
java.util.Set<java.lang.String> |
getAllMatchingResourcesPaths(java.util.Set<java.lang.String> resourcePaths,
java.util.List<Resource> resources)
Get all the resource paths by investigated the given resource list.
|
java.util.Collection<RESTMethod> |
getAllMethods()
Returns all methods of all resources of a REST/XML service.
|
java.util.Collection<RESTCallbacks> |
getCallbacks() |
java.util.Collection<RESTParameter> |
getComponentParameters()
Gets the parameters of the resource
|
boolean |
getComponentSlot(CentraSiteRegistryObject centraSiteRegistryObject) |
java.lang.String |
getCustomURL() |
java.util.Map<java.lang.String,java.lang.String> |
getEndPoints()
Get the endpoint URI appended with each resource name.
|
java.util.Collection<java.lang.String> |
getEndpointsWithSandbox(java.lang.String categoryId)
For a given
Category id, this method returns a collection of endpoint URIs which
are classified with the category id for the Sandbox. |
java.lang.String |
getEndpointUri()
Gets the endpoint URI for the service.
|
java.util.Collection<java.lang.String> |
getEndPointURIs()
Gets the endpoint URIs for the service.
|
java.util.Collection<RESTExample> |
getExamples() |
java.util.Collection<RESTParameter> |
getHeaderParameters()
Gets the header parameters that are defined for the encoding object.
|
java.util.Collection<CentraSiteFile> |
getImporterDocuments()
Returns the collection of specification files that this REST service was imported from.
|
java.util.Collection<RESTLink> |
getLinkObjects() |
java.lang.String |
getNamespace()
Get the namespace for the service.
|
java.util.Collection<RESTParameter> |
getParameters()
Gets the parameters of the REST/XML Service
|
java.util.Collection<Category> |
getRequestContentTypes()
Retrieves the request content types defined in the designated REST method.
|
java.util.Collection<RESTPayload> |
getRequestPayloads()
Gets request payloads
RESTPayload of the method object. |
Resource |
getResource(java.lang.String resourceId)
Get a particular resource of a service by its UUID.
|
java.util.List<Resource> |
getResources()
Get the resources for the service.
|
java.util.Collection<Category> |
getResponseContentTypes()
Retrieves the response content types defined in the designated REST method.
|
java.util.Collection<RESTPayload> |
getResponsePayloads()
Gets response payloads
RESTPayload of the method object. |
java.util.Collection<CentraSiteRegistryObject> |
getRestCompositeObjects() |
java.util.Collection<RESTServer> |
getRESTServers() |
java.util.Collection<RESTSchema> |
getSchemas()
Gets the list of nested schemas defined on the schema
|
java.util.Collection<ApiSecurityScheme> |
getSecuritySchemes()
Returns the collection of security schemes applicable for this API.
|
java.util.List<Resource> |
getSelectedResources(java.util.List<Resource> resources,
java.util.List<Resource> selectableResources,
java.util.List<java.lang.String> selectedResources)
Extract the resource objects which have been selected by 'selectedResources' out from the total resource
list with respect to given set of 'selectableResources'.
|
Resource |
getTopLevelResource()
For every REST/XML service, there can be only one top-level resource.
|
java.util.Collection<java.lang.String> |
getUnsupportedHttpMethods()
Get the HTTP methods (as IDs of their Categories) which are not supported of the particular service.
|
java.lang.String |
getVirtualTypeName()
Get the virtual type name for a native service.
|
boolean |
isDeleteAllowed(java.lang.String deleteObjId) |
boolean |
isTopLevelResource(Resource resource)
Decides if the given resource object is treated as a top level one.
|
java.lang.String |
schemaAccessUrl(java.lang.String schemaId)
Get the schema access URL for the given schema Id.
|
void |
setCallbacks(java.util.Collection<RESTCallbacks> restCallbacks) |
void |
setComponentParameters(java.util.Collection<RESTParameter> restParameters)
Defines a collection of parameters for the designated resource.
|
void |
setComponentSlot(CentraSiteRegistryObject registryObject,
java.lang.String content) |
void |
setCustomURL(java.lang.String customURI) |
void |
setEndpointsWithSandbox(java.util.Map<java.lang.String,Category> endpointSandboxMap)
Sets the endpoint URIs for the REST/XML service and also classifies each endpoint to a Sandbox taxonomy.
|
void |
setEndpointUri(java.lang.String endpointUri)
Deprecated.
use
AbstractXMLService.setEndPointURIs(Collection instead. |
void |
setEndPointURIs(java.util.Collection<java.lang.String> endPointURIs)
Sets the endpoint URIs for the REST/XML service.
|
void |
setExamples(java.util.Collection<RESTExample> restParameters) |
void |
setHeaderParameters(java.util.Collection<RESTParameter> restParameters)
Sets list of parameters of type 'Header' which can be used in the encoding object.
|
void |
setImporterDocuments(Category importerCategory,
java.util.LinkedHashMap<java.lang.String,java.lang.String> filePathAndNameMap)
Sets the document(s) which were imported to create a REST API in CentraSite.
|
void |
setLinkObjects(java.util.Collection<RESTLink> restLinks) |
void |
setNamespace(java.lang.String namespace)
Set the service namespace.
|
void |
setParameters(java.util.Collection<RESTParameter> restParameters)
Sets the list of parameters on the REST/XML Service
|
void |
setRequestContentTypes(java.util.Collection<Category> requestContentTypes)
Defines the request content types that are supported by the designated REST method
|
void |
setRequestPayloads(java.util.Collection<RESTPayload> requestPayloads)
Sets the request payload objects of type
RESTPayload for the RESTMethod object |
void |
setResources(java.util.List<Resource> resources)
Set the resources for the service.
|
void |
setResponseContentTypes(java.util.Collection<Category> responseContentTypes)
Defines the response content types that are supported by the designated REST method.
|
void |
setResponsePayloads(java.util.Collection<RESTPayload> responsePayloads)
Sets response payloads of type
RESTPayload for RESTMethod object. |
void |
setRESTServers(java.util.Collection<RESTServer> restServers) |
void |
setRESTServersAsMap(java.util.Map<RESTServer,java.util.Set<java.lang.String>> serverVariableMap,
java.util.Map<java.lang.String,Category> endpointSandboxMap) |
void |
setSchemas(java.util.Collection<RESTSchema> schemas)
Defines a set of nested schemas for the designated schema.
|
void |
setSecuritySchemes(java.util.Collection<ApiSecurityScheme> schemes)
Sets the security schemes applicable for this API.
|
getAPIStatusInGateway, getOperations, getOperationsMap, getServiceBindings, isRuntimeAllowed
getConsumedAssets, getConsumers, getDescription, getDescription, getDisplayVersion, getInitialVirtualAssetName, getLastModifiedTimeStamp, getLCMAssignment, getLocalName, getMandatoryAttributeProfiles, getName, getName, getNameSpace, getNextVersion, getNextVersions, getOrganization, getOwner, getPendingApprovals, getPreviousVersion, getPreviousVersions, getRegistryObject, getRelationShipValueMap, getRequestedUser, getSubscribers, getSystemVersion, getTitle, getType, getUserVersion, getVisiblePrimaryProfiles, getVisibleProfile, isDeployedOn, isLatestVersionObject, isPropagatePermissions, isPropagateProfilePermissions, removeConsumedAssets, removeConsumers, setDescription, setDescription, setDisplayVersion, setLCMState, setLocalName, setName, setName, setNameSpace, setOrganization, setOwner, setPropagatePermissions, setPropagateProfilePermissions, setRelationShipValueMap, setUserVersion
delete, getAttributeLink, getAttributeValue, getAttributeValue, getAttributeValue, getId, isModified, isPredefined, isReadOnly, save, setAttributeValue, setAttributeValue, setAttributeValue
void setEndpointUri(java.lang.String endpointUri) throws CLLException
AbstractXMLService.setEndPointURIs(Collection endPointURIs)
instead.endpointUri
- The endpoint URI to set for the serviceCLLException
- If an error occurs while trying to set the endpoint URIjava.lang.String getEndpointUri() throws CLLException
CLLException
- If an error occurs while trying to get the endpoint URI from CentraSitevoid setEndPointURIs(java.util.Collection<java.lang.String> endPointURIs) throws CLLException
endPointURIs
- The endpoint URIs to set for the serviceCLLException
- If an error occurs while trying to set the endpoint URIsvoid setEndpointsWithSandbox(java.util.Map<java.lang.String,Category> endpointSandboxMap) throws CLLException
endpointSandboxMap
- The Map
containing the endpoints as the key and the Category
as the value.
If the Category
value for the endpoint is null
, then the endpoint is not classified with any category.CLLException
- If an error occurs while trying to set the endpointsjava.util.Collection<java.lang.String> getEndPointURIs() throws CLLException
CLLException
- If an error occurs while trying to get the endpoint URIs from CentraSitejava.util.Map<java.lang.String,Category> getAllEndpointsWithSandbox() throws CLLException
Map
containing the endpoints as key with the corresponding Category
as the value.
If the endpoint is not classified with any category, then the value is null
CLLException
- If an error occurs while trying to get all the endpointsjava.util.Collection<java.lang.String> getEndpointsWithSandbox(java.lang.String categoryId) throws CLLException
Category
id, this method returns a collection of endpoint URIs which
are classified with the category id for the Sandbox.categoryId
- The Category
id belonging to the Sandbox taxonomyCollection
of String
endpoints which belong to the given category, null
if none are classified with it.CLLException
- If an error occurs while trying to get the endpoints by classificationvoid setNamespace(java.lang.String namespace) throws CLLException
namespace
- The namespace to set for the serviceCLLException
- If an error occurs while trying to set the value in CentraSitejava.lang.String getNamespace() throws CLLException
CLLException
- If an error occurs while trying to get the value from CentraSitevoid setRequestContentTypes(java.util.Collection<Category> requestContentTypes) throws CLLException
requestContentTypes
- The Collection
of Category
that represents the content types in CentraSite.CLLException
- If an error occurs while fetching the HTTP Method category of the method from CentraSite.java.util.Collection<Category> getRequestContentTypes() throws CLLException
Collection
of Category
represents content types in CentraSite.CLLException
- If an error occurs while setting the request content types of the method object in CentraSite.void setResponseContentTypes(java.util.Collection<Category> responseContentTypes) throws CLLException
responseContentTypes
- The Collection
of Category
that represents content types in CentraSite.CLLException
- If an error occurs while fetching the request content types of the method object.java.util.Collection<Category> getResponseContentTypes() throws CLLException
Collection
of Category
represents content types in CentraSite.CLLException
- If an error occurs while setting the response content types of the method object.java.util.List<Resource> getResources() throws CLLException
List
of Resource
objects that the service supportsCLLException
- If an error occurs while trying to get the value from CentraSitevoid setResources(java.util.List<Resource> resources) throws CLLException
resources
- The Resource
List
for the serviceCLLException
- If an error occurs while trying to set the value in CentraSiteResource getResource(java.lang.String resourceId) throws CLLException
resourceId
- The unique identifier for the resourceResource
corresponding to the resourceIdCLLException
- If an error occurs while trying to get the resource from CentraSitejava.lang.String schemaAccessUrl(java.lang.String schemaId) throws CLLException
schemaId
- The UUID key for the XML schema instanceCLLException
- If an error occurs while fetching the URLjava.lang.String fileAccessUrl(CentraSiteFile file) throws CLLException
file
- The CentraSiteFile
instance which represents an attached documentCLLException
- If an error occurs while fetching the URLjava.util.Map<java.lang.String,java.lang.String> getEndPoints() throws CLLException
Map
having the resource ids and the endpoint URLs.CLLException
- If an error occurs while trying to construct the endpoint URLsResource getTopLevelResource() throws CLLException
Resource
for the serviceCLLException
- If an error occurs while trying to get the value from CentraSitejava.util.Collection<RESTParameter> getParameters() throws CLLException
RESTParameter
of this service.CLLException
- If an error occurs when fetching the value from CentraSitevoid setParameters(java.util.Collection<RESTParameter> restParameters) throws CLLException
restParameters
- The Collection
of RESTParameter
objects which
should be set as the API level parametersCLLException
- If an error occurs while trying to set the value in CentraSiteboolean checkRouteToEndpoint() throws CLLException
CLLException
- If an error occurs while trying to check if the endpoint has to be reconfiguredvoid setSecuritySchemes(java.util.Collection<ApiSecurityScheme> schemes) throws CLLException
schemes
- The Collection
of ApiSecurityScheme
instances to set.CLLException
- If an error occurs while setting the security schemes.java.util.Collection<ApiSecurityScheme> getSecuritySchemes() throws CLLException
Collection
of ApiSecurityScheme
instances.CLLException
- If an error occurs while fetching the applicable security schemes.void setImporterDocuments(Category importerCategory, java.util.LinkedHashMap<java.lang.String,java.lang.String> filePathAndNameMap) throws CLLException
importerCategory
- The Category
indicating the importer specification file categoryfileNameAndPathMap
- A LinkedHashMap
containing the fully qualified file path as the key and the file name
to save as the value. The first entry in the map should point to the main specification file and the rest of
the entries in map can point to references of the main document (if any).CLLException
- If the given files are not accessible or if there are any errors in associating the
given files to the REST Service.java.util.Collection<CentraSiteFile> getImporterDocuments() throws CLLException
Collection
of CentraSiteFile
references where the first file in the collection
indicates the main importer document and the subsequent files in the collection indicate the referenced files
for the main importer document or null
if the REST service was not created by importing any
specification file.CLLException
- If an error occurs while retrieving the importer documentsjava.lang.String getCustomURL() throws CLLException
CLLException
void setCustomURL(java.lang.String customURI) throws CLLException
CLLException
java.util.Collection<java.lang.String> getUnsupportedHttpMethods()
java.lang.String getVirtualTypeName()
void generateWSDL20() throws java.lang.Exception
java.lang.Exception
boolean isTopLevelResource(Resource resource) throws CLLException
resource
- a resource objectCLLException
java.util.List<Resource> getSelectedResources(java.util.List<Resource> resources, java.util.List<Resource> selectableResources, java.util.List<java.lang.String> selectedResources) throws CLLException
resources
- all resources from a serviceselectableResources
- list of selectable resourcesselectedResources
- resource paths which have been selectedCLLException
java.util.Set<java.lang.String> getAllMatchingResourcesPaths(java.util.Set<java.lang.String> resourcePaths, java.util.List<Resource> resources) throws CLLException
resourcePathes
- a list of resource pathsresources
- all present resource objectsCLLException
java.util.Collection<RESTMethod> getAllMethods() throws CLLException
CLLException
void setRESTServersAsMap(java.util.Map<RESTServer,java.util.Set<java.lang.String>> serverVariableMap, java.util.Map<java.lang.String,Category> endpointSandboxMap) throws CLLException
CLLException
java.util.Collection<RESTParameter> getComponentParameters() throws CLLException
Collection
of RESTParameter
associated to the RESTServer.CLLException
- If an error occurs while fetching the parameters of the RESTServer.void setComponentParameters(java.util.Collection<RESTParameter> restParameters) throws CLLException
restParameters
- The Collection
of RESTParameter
to be set on the RESTServer.CLLException
- If an error occurs while setting the parameters for the RESTServer.java.util.Collection<RESTParameter> getHeaderParameters() throws CLLException
RESTParameter>
CLLException
- If an error occurs while fetching the parameters on the encoding object.void setHeaderParameters(java.util.Collection<RESTParameter> restParameters) throws CLLException
parameters
- The Collection
of RESTParameter
to be set for the encoding object.CLLException
- If an error occurs while setting the parameters on the encoding object.void setRequestPayloads(java.util.Collection<RESTPayload> requestPayloads) throws CLLException
RESTPayload
for the RESTMethod
objectrequestPayloads
- CLLException
- If an error occurs while setting request payloads for the method object.java.util.Collection<RESTPayload> getRequestPayloads() throws CLLException
RESTPayload
of the method object.RESTPayload
of the RESTMethod
object.CLLException
void setResponsePayloads(java.util.Collection<RESTPayload> responsePayloads) throws CLLException
RESTPayload
for RESTMethod
object.responsePayloads
- CLLException
java.util.Collection<RESTPayload> getResponsePayloads() throws CLLException
RESTPayload
of the method object.CLLException
java.util.Collection<RESTExample> getExamples() throws CLLException
CLLException
void setExamples(java.util.Collection<RESTExample> restParameters) throws CLLException
CLLException
java.util.Collection<RESTSchema> getSchemas() throws CLLException
Collection
of RESTSchema
defined on the schema.CLLException
- If an error occurs while setting the nested schemas for the schema.void setSchemas(java.util.Collection<RESTSchema> schemas) throws CLLException
schemas
- The Collection
of RESTSchema
schema.CLLException
- If an error occurs while trying to set the nested schema objects to the schema.java.util.Collection<RESTLink> getLinkObjects() throws CLLException
CLLException
void setLinkObjects(java.util.Collection<RESTLink> restLinks) throws CLLException
CLLException
java.util.Collection<RESTCallbacks> getCallbacks() throws CLLException
CLLException
void setCallbacks(java.util.Collection<RESTCallbacks> restCallbacks) throws CLLException
CLLException
java.util.Collection<RESTServer> getRESTServers() throws CLLException
CLLException
void setRESTServers(java.util.Collection<RESTServer> restServers) throws CLLException
CLLException
void setComponentSlot(CentraSiteRegistryObject registryObject, java.lang.String content) throws CLLException
CLLException
boolean getComponentSlot(CentraSiteRegistryObject centraSiteRegistryObject) throws CLLException
CLLException
boolean isDeleteAllowed(java.lang.String deleteObjId) throws CLLException
CLLException
java.util.Collection<CentraSiteRegistryObject> getRestCompositeObjects()