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 |
---|---|
java.lang.String |
fileAccessUrl(CentraSiteFile file)
Get the access URL for a file attached to the service.
|
java.util.Map<java.lang.String,java.lang.String> |
getEndPoints()
Get the endpoint URI appended with each resource name.
|
java.lang.String |
getEndpointUri()
Gets the endpoint URI for the service.
|
java.lang.String |
getNamespace()
Get the namespace for the service.
|
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.
|
Resource |
getTopLevelResource()
For every REST/XML service, there can be only one top-level resource.
|
java.lang.String |
schemaAccessUrl(java.lang.String schemaId)
Get the schema access URL for the given schema Id.
|
void |
setEndpointUri(java.lang.String endpointUri)
Sets the endpoint URL for the REST/XML service.
|
void |
setNamespace(java.lang.String namespace)
Set the service namespace.
|
void |
setResources(java.util.List<Resource> resources)
Set the resources for the service.
|
getOperationsMap
getConsumers, getDescription, getDescription, getDisplayVersion, getLCMAssignment, getLocalName, getMandatoryAttributeProfiles, getName, getName, getNameSpace, getNextVersion, getNextVersions, getOrganization, getOwner, getPendingApprovals, getPreviousVersion, getPreviousVersions, getRegistryObject, getSubscribers, getSystemVersion, getTitle, getUserVersion, getVisiblePrimaryProfiles, getVisibleProfile, isDeployedOn, isLatestVersionObject, isPropagatePermissions, isPropagateProfilePermissions, setDescription, setDescription, setDisplayVersion, setLCMState, setLocalName, setName, setName, setNameSpace, setOrganization, setOwner, setPropagatePermissions, setPropagateProfilePermissions, setUserVersion
delete, getAttributeLink, getAttributeValue, getAttributeValue, getAttributeValue, getId, getType, isModified, isReadOnly, save, setAttributeValue, setAttributeValue, setAttributeValue
void setEndpointUri(java.lang.String endpointUri) throws CLLException
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 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 CentraSitejava.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 CentraSite