eu.europeana.cloud.mcs.driver

Class RevisionServiceClient

java.lang.Object

eu.europeana.cloud.mcs.driver.MCSClient

eu.europeana.cloud.mcs.driver.RevisionServiceClient

public class RevisionServiceClient
extends MCSClient

Created by Tarek on 8/2/2016.

Field Summary

Fields inherited from class eu.europeana.cloud.mcs.driver.MCSClient

baseUrl

Constructor Summary

Constructors

Constructor and Description
RevisionServiceClient(String baseUrl) Constructs a RevisionServiceClient
RevisionServiceClient(String baseUrl, String username, String password) Creates instance of RevisionServiceClient.

Method Summary

Methods

Modifier and Type	Method and Description
URI	addRevision(String cloudId, String representationName, String version, eu.europeana.cloud.common.model.Revision revision) add a revision
URI	addRevision(String cloudId, String representationName, String version, String revisionName, String revisionProviderId, Set<eu.europeana.cloud.common.utils.Tags> tags) add a revision
URI	addRevision(String cloudId, String representationName, String version, String revisionName, String revisionProviderId, String tag) add a revision
void	useAuthorizationHeader(String headerValue)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RevisionServiceClient

public RevisionServiceClient(String baseUrl)

Constructs a RevisionServiceClient

Parameters:

baseUrl - url of the MCS Rest Service

RevisionServiceClient

public RevisionServiceClient(String baseUrl,
                     String username,
                     String password)

Creates instance of RevisionServiceClient. Same as RevisionServiceClient(String) but includes username and password to perform authenticated requests.

Parameters:

baseUrl - URL of the MCS Rest Service

Method Detail

useAuthorizationHeader

public void useAuthorizationHeader(String headerValue)

addRevision

public URI addRevision(String cloudId,
              String representationName,
              String version,
              String revisionName,
              String revisionProviderId,
              String tag)
                throws DriverException,
                       eu.europeana.cloud.service.mcs.exception.MCSException

add a revision

Parameters:

cloudId - id of uploaded revision.

representationName - representation name of uploaded revision.

version - a specific version of the representation.

revisionName - the name of revision

revisionProviderId - revision provider id

tag - flag tag

Returns:

URI to specific revision with specific tag inside a version.

Throws:

DriverException - call to service has not succeeded because of server side error.

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations.

addRevision

public URI addRevision(String cloudId,
              String representationName,
              String version,
              eu.europeana.cloud.common.model.Revision revision)
                throws DriverException,
                       eu.europeana.cloud.service.mcs.exception.MCSException

add a revision

Parameters:

cloudId - id of uploaded revision.

representationName - representation name of uploaded revision.

version - a specific version of the representation.

revision - revision

Returns:

URI to revisions inside a version.

Throws:

eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException - when representation does not exist in specified version.

DriverException - call to service has not succeeded because of server side error.

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations.

addRevision

public URI addRevision(String cloudId,
              String representationName,
              String version,
              String revisionName,
              String revisionProviderId,
              Set<eu.europeana.cloud.common.utils.Tags> tags)
                throws DriverException,
                       eu.europeana.cloud.service.mcs.exception.MCSException

add a revision

Parameters:

cloudId - cloud id of the record (required).

representationName - schema of representation (required).

version - a specific version of the representation(required).

revisionName - the name of revision (required).

revisionProviderId - revision provider id (required).

tags - set of tags (acceptance,published,deleted)

Returns:

URI to a revision tags inside a version.

Throws:

eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException - when representation does not exist in specified version.

DriverException - call to service has not succeeded because of server side error.

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations.