|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RegistryService
Method Summary | |
---|---|
void |
changeObjectStatus(String user,
String guid,
ObjectAction action,
Class<? extends RegistryObject> objectClass)
Changes the status of registry object with the given guid and of the given type |
void |
changeStatusOfPackageMembers(String user,
String packageId,
ObjectAction action)
Changes the status of all registry objects that are members of the package. |
String |
configure(String user,
RegistryPackage registryPackage,
List<? extends RegistryObject> list)
Configures the registry with a list of registry objects as input. |
void |
deleteObject(String user,
String guid,
Class<? extends RegistryObject> objectClass)
Deletes a RegistryObject from the registry which share the logical
identifier and version. |
void |
deletePackageMembers(String user,
String packageId)
Removes all registry objects that are associated with the package. |
Association |
getAssocation(String guid)
Retrieves the Association from the registry with the given guid |
PagedResponse<Association> |
getAssociations(RegistryQuery<AssociationFilter> query,
Integer start,
Integer rows)
Retrieves a set of associations that match the given query. |
PagedResponse<AuditableEvent> |
getAuditableEvents(RegistryQuery<EventFilter> query,
Integer start,
Integer rows)
Retrieves the list of (@link AuditableEvent}'s matching the query |
PagedResponse<AuditableEvent> |
getAuditableEvents(String affectedObject)
Retrieves the list of (@link AuditableEvent}'s for the affected object |
List<ClassificationNode> |
getClassificationNodes(String scheme)
Retrieves all ClassificationNode for a given
ClassificationScheme |
RegistryObject |
getEarliestObject(String lid,
Class<? extends RegistryObject> objectClass)
Retrieves the earliest version of the RegsitryObject with the given
logical identifier |
ExtrinsicObject |
getExtrinsic(String guid)
Retrieves a ExtrinsicObject from the registry |
PagedResponse<ExtrinsicObject> |
getExtrinsics(Integer start,
Integer rows)
This method allows one to page through the ExtrinsicObject 's in the
registry. |
PagedResponse<ExtrinsicObject> |
getExtrinsics(RegistryQuery<ExtrinsicFilter> query)
Retrieves the first set of extrinsics that match the query |
PagedResponse<ExtrinsicObject> |
getExtrinsics(RegistryQuery<ExtrinsicFilter> query,
Integer start,
Integer rows)
Retrieves a set of extinsics that match the given query. |
IdentifierGenerator |
getIdentifierGenerator()
|
RegistryObject |
getLatestObject(String lid,
Class<? extends RegistryObject> objectClass)
Retrieves the latest version of the RegistryObject with the given
logical identifier |
MetadataStore |
getMetadataStore()
Get access to the back end store for the registry service. |
RegistryObject |
getNextObject(String guid,
Class<? extends RegistryObject> objectClass)
Retrieves the next version of the RegsitryObject |
RegistryObject |
getObject(String guid,
Class<? extends RegistryObject> objectClass)
Retrieves a registry object of the requested type |
RegistryObject |
getObject(String lid,
String versionName,
Class<? extends RegistryObject> objectClass)
|
PagedResponse<? extends RegistryObject> |
getObjects(RegistryQuery<ObjectFilter> query,
Integer start,
Integer rows,
Class<? extends RegistryObject> objectClass)
Generic query for a given class of registry objects. |
List<RegistryObject> |
getObjectVersions(String lid,
Class<? extends RegistryObject> objectClass)
Retrieves all versions of a RegistryObject |
RegistryObject |
getPreviousObject(String guid,
Class<? extends RegistryObject> objectClass)
Retrieves the previous version of the RegistryObject |
ReplicationReport |
getReplicationReport()
Get the inform about the current replication event. |
Report |
getReport()
Gives back some basic summary information about the registry. |
Versioner |
getVersioner()
|
Boolean |
hasReplicationInProgress()
A check to see if replication is currently under way by the registry. |
void |
performReplication(String user,
String registryUrl,
Date lastModified)
Replicates contents from a remote registry connected to using the provided URL. |
String |
publishObject(String user,
RegistryObject registryObject)
Publishes a registry object to the registry. |
String |
publishObject(String user,
RegistryObject registryObject,
String packageId)
Publishes a registry object to the registry. |
void |
setIdentifierGenerator(IdentifierGenerator idGenerator)
Sets the class used to generate unique ids for registry objects |
void |
setMetadataStore(MetadataStore metadataStore)
Set where to store all the metadata for registry objects. |
void |
setVersioner(Versioner versioner)
Sets the class used to generate and sort versions for registry objects. |
void |
updateObject(String user,
RegistryObject registryObject)
This method allows one to update all the metadata associated with a registry object. |
String |
versionObject(String user,
RegistryObject object,
boolean major)
Versions a RegistryObject in the registry and publishes the
contents of the provided extrinsic object. |
String |
versionObject(String user,
RegistryObject registryObject,
boolean major,
String packageId)
Versions a RegistryObject in the registry and publishes the
contents of the provided extrinsic object. |
Method Detail |
---|
void setMetadataStore(MetadataStore metadataStore)
metadataStore
- for registry object metadataMetadataStore getMetadataStore()
void setVersioner(Versioner versioner)
versioner
- to use when generating a new version of a registry object.Versioner getVersioner()
void setIdentifierGenerator(IdentifierGenerator idGenerator)
idGenerator
- to use to generate a guid for registry objects when there is not
one supplied by clients.IdentifierGenerator getIdentifierGenerator()
PagedResponse<ExtrinsicObject> getExtrinsics(Integer start, Integer rows)
ExtrinsicObject
's in the
registry.
start
- the index at which to start the result list fromrows
- how many results to return
PagedResponse<ExtrinsicObject> getExtrinsics(RegistryQuery<ExtrinsicFilter> query)
query
- holds a set of filters to match against extrinsics
PagedResponse<ExtrinsicObject> getExtrinsics(RegistryQuery<ExtrinsicFilter> query, Integer start, Integer rows)
query
- holds a set of filters to match against ExtrinsicObject
'sstart
- the index at which to start the result list from. This index
starts at one and if anything less than one is provided it will
default to one.rows
- how many results to return
Report getReport()
String versionObject(String user, RegistryObject object, boolean major) throws RegistryServiceException
RegistryObject
in the registry and publishes the
contents of the provided extrinsic object. A registry object with the the
same lid must be already published otherwise there will be nothing to
version off of.
user
- that has taken the action. Typically this should point to a unique
username.registryObject
- the contents for this version of the extrinsic objectmajor
- flag to indicate whether this is a minor or major version
RegistryServiceException
String versionObject(String user, RegistryObject registryObject, boolean major, String packageId) throws RegistryServiceException
RegistryObject
in the registry and publishes the
contents of the provided extrinsic object. A registry object with the the
same lid must be already published otherwise there will be nothing to
version off of.
user
- that has taken the action. Typically this should point to a unique
username.registryObject
- the contents for this version of the extrinsic objectmajor
- flag to indicate whether this is a minor or major versionpackageId
- to associate this version event with
RegistryServiceException
RegistryObject getLatestObject(String lid, Class<? extends RegistryObject> objectClass) throws RegistryServiceException
RegistryObject
with the given
logical identifier
lid
- of extrinsic to look up
RegistryServiceException
RegistryObject getEarliestObject(String lid, Class<? extends RegistryObject> objectClass) throws RegistryServiceException
RegsitryObject
with the given
logical identifier
lid
- of registry object to look upobjectClass
- the type of object to look up
RegistryServiceException
RegistryObject getNextObject(String guid, Class<? extends RegistryObject> objectClass) throws RegistryServiceException
RegsitryObject
guid
- of the registry object to uniquely identify itobjectClass
- the type of object to look up
RegistryServiceException
RegistryObject getPreviousObject(String guid, Class<? extends RegistryObject> objectClass) throws RegistryServiceException
RegistryObject
guid
- of the registry object to uniquely identify itobjectClass
- the type of object to look up
RegistryServiceException
List<RegistryObject> getObjectVersions(String lid, Class<? extends RegistryObject> objectClass) throws RegistryServiceException
RegistryObject
lid
- of the registry object of interestobjectClass
- the type of object to look up
RegistryServiceException
List<ClassificationNode> getClassificationNodes(String scheme)
ClassificationNode
for a given
ClassificationScheme
scheme
- guid for which to get the classification nodes for
void changeObjectStatus(String user, String guid, ObjectAction action, Class<? extends RegistryObject> objectClass)
user
- that is requesting the changeguid
- of the registry object to uniquely identify itaction
- which to take (i.e. approve, deprecate, etc.)objectClass
- identifies the type of registry objectvoid updateObject(String user, RegistryObject registryObject) throws RegistryServiceException
user
- that is requesting the updateregistryObject
- to update too. The update is made to the object with the same guid
RegistryServiceException
PagedResponse<Association> getAssociations(RegistryQuery<AssociationFilter> query, Integer start, Integer rows)
query
- holds a set of filters to match against Association
'sstart
- the index at which to start the result list from. This index
starts at one and if anything less than one is provided it will
default to one.rows
- how many results to return
PagedResponse<? extends RegistryObject> getObjects(RegistryQuery<ObjectFilter> query, Integer start, Integer rows, Class<? extends RegistryObject> objectClass)
query
- based on a set of filtersstart
- index within the results to start at. This index is one basedrows
- number of results to getobjectClass
- the type of registry object to look for
RegistryObject
with the given classPagedResponse<AuditableEvent> getAuditableEvents(String affectedObject)
affectedObject
- guid for the registry object of interest
PagedResponse<AuditableEvent> getAuditableEvents(RegistryQuery<EventFilter> query, Integer start, Integer rows)
query
- to filter out eventsstart
- index within the results to start at. This index is one basedrows
- number of results to get
String publishObject(String user, RegistryObject registryObject) throws RegistryServiceException
user
- that is requesting the object to be publishedregistryObject
- to publish
RegistryServiceException
String publishObject(String user, RegistryObject registryObject, String packageId) throws RegistryServiceException
user
- that is requesting the object to be publishedregistryObject
- to publishpackageId
- to associate this publish event with
RegistryServiceException
void deleteObject(String user, String guid, Class<? extends RegistryObject> objectClass)
RegistryObject
from the registry which share the logical
identifier and version.
user
- that requested the deleteguid
- globally unique identifier of the registry objectobjectClass
- type of registry objectAssociation getAssocation(String guid) throws RegistryServiceException
Association
from the registry with the given guid
guid
- globally unique identifier of the registry object
RegistryServiceException
ExtrinsicObject getExtrinsic(String guid) throws RegistryServiceException
ExtrinsicObject
from the registry
guid
- globally unique identifier of the extrinsic object
RegistryServiceException
RegistryObject getObject(String guid, Class<? extends RegistryObject> objectClass) throws RegistryServiceException
guid
- globally unique identifier of the objectobjectClass
- type of the registry object
RegistryServiceException
RegistryObject getObject(String lid, String versionName, Class<? extends RegistryObject> objectClass)
lid
- logical identifier which correlates to a group of related registry
objectsversionName
- that specifially identifies an object withing the groupobjectClass
- type of registry object that is being looked for
String configure(String user, RegistryPackage registryPackage, List<? extends RegistryObject> list) throws RegistryServiceException
user
- that has taken the action. Typically this should point to a unique
username.registryPackage
- to associate objects tolist
- classification schemes and nodes that are apart of this config
RegistryServiceException
void deletePackageMembers(String user, String packageId) throws RegistryServiceException
user
- that has taken the action. Typically this should point to a unique
username.packageId
- unique guid of the package to delete members from
RegistryServiceException
void changeStatusOfPackageMembers(String user, String packageId, ObjectAction action) throws RegistryServiceException
user
- that has taken the action. Typically this should point to a unique
username.packageId
- unique guid of the package to update members status fromaction
- which to take (i.e. approve, deprecate, etc.)
RegistryServiceException
void performReplication(String user, String registryUrl, Date lastModified) throws RegistryServiceException
user
- that has taken the action. Typically this should point to a unique
username.registryUrl
- to pull registry object from to replicate locallylastModified
- time to constrain which registry objects are relevant to
replicate. This time is inclusive. If set to null all will be
pulled.
RegistryServiceException
- if another replication is already taking placeReplicationReport getReplicationReport()
Boolean hasReplicationInProgress()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |