public interface RegistryService
Modifier and Type | Method and Description |
---|---|
void |
changeObjectStatus(java.lang.String user,
java.lang.String guid,
ObjectAction action,
java.lang.Class<? extends RegistryObject> objectClass)
Changes the status of registry object with the given guid and of the given
type
|
void |
changeStatusOfPackageMembers(java.lang.String user,
java.lang.String packageId,
ObjectAction action)
Changes the status of all registry objects that are members of the package.
|
void |
changeStatusOfPackageMembersWithQuery(java.lang.String user,
java.lang.String packageId,
ObjectAction action) |
java.lang.String |
configure(java.lang.String user,
RegistryPackage registryPackage,
java.util.List<? extends RegistryObject> list)
Configures the registry with a list of registry objects as input.
|
void |
deleteObject(java.lang.String user,
java.lang.String guid,
java.lang.Class<? extends RegistryObject> objectClass)
Deletes a
RegistryObject from the registry which share the logical
identifier and version. |
void |
deletePackageMembers(java.lang.String user,
java.lang.String packageId)
Removes all registry objects that are associated with the package.
|
void |
deletePackageMembersWithQuery(java.lang.String user,
java.lang.String packageId) |
Association |
getAssocation(java.lang.String guid)
Retrieves the
Association from the registry with the given guid |
PagedResponse<Association> |
getAssociations(RegistryQuery<AssociationFilter> query,
java.lang.Integer start,
java.lang.Integer rows)
Retrieves a set of associations that match the given query.
|
PagedResponse<AuditableEvent> |
getAuditableEvents(RegistryQuery<EventFilter> query,
java.lang.Integer start,
java.lang.Integer rows)
Retrieves the list of (@link AuditableEvent}'s matching the query
|
PagedResponse<AuditableEvent> |
getAuditableEvents(java.lang.String affectedObject)
Retrieves the list of (@link AuditableEvent}'s for the affected object
|
java.util.List<ClassificationNode> |
getClassificationNodes(java.lang.String scheme)
Retrieves all
ClassificationNode for a given
ClassificationScheme |
RegistryObject |
getEarliestObject(java.lang.String lid,
java.lang.Class<? extends RegistryObject> objectClass)
Retrieves the earliest version of the
RegsitryObject with the given
logical identifier |
ExtrinsicObject |
getExtrinsic(java.lang.String guid)
Retrieves a
ExtrinsicObject from the registry |
PagedResponse<ExtrinsicObject> |
getExtrinsics(java.lang.Integer start,
java.lang.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,
java.lang.Integer start,
java.lang.Integer rows)
Retrieves a set of extinsics that match the given query.
|
IdentifierGenerator |
getIdentifierGenerator() |
RegistryObject |
getLatestObject(java.lang.String lid,
java.lang.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(java.lang.String guid,
java.lang.Class<? extends RegistryObject> objectClass)
Retrieves the next version of the
RegsitryObject |
RegistryObject |
getObject(java.lang.String guid,
java.lang.Class<? extends RegistryObject> objectClass)
Retrieves a registry object of the requested type
|
RegistryObject |
getObject(java.lang.String lid,
java.lang.String versionName,
java.lang.Class<? extends RegistryObject> objectClass) |
PagedResponse<? extends RegistryObject> |
getObjects(RegistryQuery<ObjectFilter> query,
java.lang.Integer start,
java.lang.Integer rows,
java.lang.Class<? extends RegistryObject> objectClass)
Generic query for a given class of registry objects.
|
java.util.List<RegistryObject> |
getObjectVersions(java.lang.String lid,
java.lang.Class<? extends RegistryObject> objectClass)
Retrieves all versions of a
RegistryObject |
PagedResponse<RegistryPackage> |
getPackages(RegistryQuery<PackageFilter> query,
java.lang.Integer start,
java.lang.Integer rows)
Generic query for a given class of registry packages.
|
RegistryObject |
getPreviousObject(java.lang.String guid,
java.lang.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() |
java.lang.Boolean |
hasReplicationInProgress()
A check to see if replication is currently under way by the registry.
|
void |
performReplication(java.lang.String user,
java.lang.String registryUrl,
java.util.Date lastModified,
java.lang.String objectType,
RegistryPackage replicationPackage)
Replicates contents from a remote registry connected to using the provided
URL.
|
java.lang.String |
publishObject(java.lang.String user,
RegistryObject registryObject)
Publishes a registry object to the registry.
|
java.lang.String |
publishObject(java.lang.String user,
RegistryObject registryObject,
java.lang.String packageId)
Publishes a registry object to the registry.
|
void |
publishObjects(java.lang.String user,
java.util.List<? extends RegistryObject> registryObjects) |
void |
publishObjects(java.lang.String user,
java.util.List<? extends RegistryObject> registryObjects,
java.lang.String packageId) |
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(java.lang.String user,
RegistryObject registryObject)
This method allows one to update all the metadata associated with a
registry object.
|
java.lang.String |
versionObject(java.lang.String user,
RegistryObject object,
boolean major)
Versions a
RegistryObject in the registry and publishes the
contents of the provided extrinsic object. |
java.lang.String |
versionObject(java.lang.String user,
RegistryObject registryObject,
boolean major,
java.lang.String packageId)
Versions a
RegistryObject in the registry and publishes the
contents of the provided extrinsic object. |
void |
versionObjects(java.lang.String user,
java.util.List<? extends RegistryObject> registryObjects,
boolean major) |
void |
versionObjects(java.lang.String user,
java.util.List<? extends RegistryObject> registryObjects,
boolean major,
java.lang.String packageId) |
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(java.lang.Integer start, java.lang.Integer rows)
ExtrinsicObject
's in the
registry.start
- the index at which to start the result list fromrows
- how many results to returnPagedResponse<ExtrinsicObject> getExtrinsics(RegistryQuery<ExtrinsicFilter> query)
query
- holds a set of filters to match against extrinsicsPagedResponse<ExtrinsicObject> getExtrinsics(RegistryQuery<ExtrinsicFilter> query, java.lang.Integer start, java.lang.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 returnReport getReport()
java.lang.String versionObject(java.lang.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 versionRegistryServiceException
void versionObjects(java.lang.String user, java.util.List<? extends RegistryObject> registryObjects, boolean major) throws RegistryServiceException
RegistryServiceException
java.lang.String versionObject(java.lang.String user, RegistryObject registryObject, boolean major, java.lang.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 withRegistryServiceException
void versionObjects(java.lang.String user, java.util.List<? extends RegistryObject> registryObjects, boolean major, java.lang.String packageId) throws RegistryServiceException
RegistryServiceException
RegistryObject getLatestObject(java.lang.String lid, java.lang.Class<? extends RegistryObject> objectClass) throws RegistryServiceException
RegistryObject
with the given
logical identifierlid
- of extrinsic to look upRegistryServiceException
RegistryObject getEarliestObject(java.lang.String lid, java.lang.Class<? extends RegistryObject> objectClass) throws RegistryServiceException
RegsitryObject
with the given
logical identifierlid
- of registry object to look upobjectClass
- the type of object to look upRegistryServiceException
RegistryObject getNextObject(java.lang.String guid, java.lang.Class<? extends RegistryObject> objectClass) throws RegistryServiceException
RegsitryObject
guid
- of the registry object to uniquely identify itobjectClass
- the type of object to look upRegistryServiceException
RegistryObject getPreviousObject(java.lang.String guid, java.lang.Class<? extends RegistryObject> objectClass) throws RegistryServiceException
RegistryObject
guid
- of the registry object to uniquely identify itobjectClass
- the type of object to look upRegistryServiceException
java.util.List<RegistryObject> getObjectVersions(java.lang.String lid, java.lang.Class<? extends RegistryObject> objectClass) throws RegistryServiceException
RegistryObject
lid
- of the registry object of interestobjectClass
- the type of object to look upRegistryServiceException
java.util.List<ClassificationNode> getClassificationNodes(java.lang.String scheme)
ClassificationNode
for a given
ClassificationScheme
scheme
- guid for which to get the classification nodes forvoid changeObjectStatus(java.lang.String user, java.lang.String guid, ObjectAction action, java.lang.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(java.lang.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 guidRegistryServiceException
PagedResponse<Association> getAssociations(RegistryQuery<AssociationFilter> query, java.lang.Integer start, java.lang.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 returnPagedResponse<? extends RegistryObject> getObjects(RegistryQuery<ObjectFilter> query, java.lang.Integer start, java.lang.Integer rows, java.lang.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 forRegistryObject
with the given classPagedResponse<RegistryPackage> getPackages(RegistryQuery<PackageFilter> query, java.lang.Integer start, java.lang.Integer rows)
query
- based on a set of filtersstart
- index within the results to start at. This index is one basedrows
- number of results to getPagedResponse<AuditableEvent> getAuditableEvents(java.lang.String affectedObject)
affectedObject
- guid for the registry object of interestPagedResponse<AuditableEvent> getAuditableEvents(RegistryQuery<EventFilter> query, java.lang.Integer start, java.lang.Integer rows)
query
- to filter out eventsstart
- index within the results to start at. This index is one basedrows
- number of results to getjava.lang.String publishObject(java.lang.String user, RegistryObject registryObject) throws RegistryServiceException
user
- that is requesting the object to be publishedregistryObject
- to publishRegistryServiceException
void publishObjects(java.lang.String user, java.util.List<? extends RegistryObject> registryObjects) throws RegistryServiceException
RegistryServiceException
java.lang.String publishObject(java.lang.String user, RegistryObject registryObject, java.lang.String packageId) throws RegistryServiceException
user
- that is requesting the object to be publishedregistryObject
- to publishpackageId
- to associate this publish event withRegistryServiceException
void publishObjects(java.lang.String user, java.util.List<? extends RegistryObject> registryObjects, java.lang.String packageId) throws RegistryServiceException
RegistryServiceException
void deleteObject(java.lang.String user, java.lang.String guid, java.lang.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(java.lang.String guid) throws RegistryServiceException
Association
from the registry with the given guidguid
- globally unique identifier of the registry objectRegistryServiceException
ExtrinsicObject getExtrinsic(java.lang.String guid) throws RegistryServiceException
ExtrinsicObject
from the registryguid
- globally unique identifier of the extrinsic objectRegistryServiceException
RegistryObject getObject(java.lang.String guid, java.lang.Class<? extends RegistryObject> objectClass) throws RegistryServiceException
guid
- globally unique identifier of the objectobjectClass
- type of the registry objectRegistryServiceException
RegistryObject getObject(java.lang.String lid, java.lang.String versionName, java.lang.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 forjava.lang.String configure(java.lang.String user, RegistryPackage registryPackage, java.util.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 configRegistryServiceException
void deletePackageMembers(java.lang.String user, java.lang.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 fromRegistryServiceException
void deletePackageMembersWithQuery(java.lang.String user, java.lang.String packageId) throws RegistryServiceException
RegistryServiceException
void changeStatusOfPackageMembers(java.lang.String user, java.lang.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 changeStatusOfPackageMembersWithQuery(java.lang.String user, java.lang.String packageId, ObjectAction action) throws RegistryServiceException
RegistryServiceException
void performReplication(java.lang.String user, java.lang.String registryUrl, java.util.Date lastModified, java.lang.String objectType, RegistryPackage replicationPackage) 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.objectType
- to filter out registry objects that should be replicated.replicationPackage
- to which replicated items will be associatedRegistryServiceException
- if another replication is already taking placeReplicationReport getReplicationReport()
java.lang.Boolean hasReplicationInProgress()
Copyright © 2010-2019 Planetary Data System. All Rights Reserved.