IEWebServices

All Superinterfaces:

com.exlibris.core.infra.svc.api.GenericWebService
```
public interface IEWebServices
extends com.exlibris.core.infra.svc.api.GenericWebService
```
Web Service for getting/updating IEs in Permanent.

Author:

zvif

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`long`	`addRepresentation(java.lang.String pdsHandle, java.lang.String iePid, java.lang.String preservationType, java.lang.String label, java.lang.String representationEntityType, java.lang.String representationCode, java.lang.String arPolicyID, java.lang.String submissionReason, RepresentationContent[] representationContent, MetaData[] metadata, java.lang.Boolean commit)` This method adds new representation, according to the given representationContent objects list.
`void`	`assignCMS(java.lang.String pdsHandle, java.lang.String pid, java.lang.String cmsSystem, java.lang.String cmsRecordId, java.lang.Boolean commit)` This method assigns CMS record to an IE, according to the given cmsSystem/cmsRecordId parameters
`void`	`assignSharedMD(java.lang.String pdsHandle, java.lang.String pid, java.lang.String mid, java.lang.Boolean commit)` Assign an Access Rights policy or exception.
`java.lang.String`	`createSharedMD(java.lang.String pdsHandle, MetaData metadata)` Creates a new Access Rights policy or exception.
`void`	`deleteSharedMD(java.lang.String pdsHandle, java.lang.String mid)` Delete an (unassigned) Access Rights policy or exception
`void`	`generateFixityEvent(java.lang.String PDShandle, FixityEvent event, java.lang.Boolean commit)` This method sends a fixity event for Rosetta to process.
`java.lang.String`	`getDNX(java.lang.String pdsHandle, java.lang.String pid, java.lang.String section)` API for getting the DNX MD of an IE , REP or File, Only MD on entity level (which is in Permanent) is returned.
`java.lang.String`	`getIE(java.lang.String pdsHandle, java.lang.String iePid, java.lang.Long flags)` Returns the METS of the IE.
`java.lang.String`	`getIEMD(java.lang.String pdsHandle, java.lang.String iePID)` Deprecated.
`java.lang.String`	`getIERepresentations(java.lang.String pdsHandle, java.lang.String iePid, java.lang.String preservationType)` Returns the Reps of the IE.
`java.lang.String`	`getMD(java.lang.String pdsHandle, java.lang.String pid, java.lang.String mid, java.lang.String type, java.lang.String subType)` API for getting the MD of an IE , REP or File, Only MD on entity level (which is in Permanent) is returned. The ID of the source MD section is the mid (saved in Rosetta DB) No parameters - return all PID's MDs MID - return matching MD (ignore type, subtype if provided) type (only) - return all matching for type type+subType - return all matching for type+subtype subType (only) - not supported type+subType mismatch - error Supported type:subType pairs: descriptive: dc source: marc, dc, mods, text_md, image_niso,video_md, audio_md, copyrights, rights, other, ead, OTHER:article mets_section: structMap Requests by users other than the locking agent will return a response with the latest committed version.
`java.lang.String`	`getRipStatus(java.lang.String pdsHandle, java.lang.Long ripID)` Returns the current status of the given rip, can be one of the following: Finished, In Process - {stage}, In TA - {stage}.
`RIPStatusInfo`	`getRipStatusInfo(java.lang.String pdsHandle, java.lang.Long ripID)` Return `RIPStatusInfo` object.
`java.util.List<MetaData>`	`getSharedMD(java.lang.String pdsHandle, java.lang.String pid, java.lang.String type, java.lang.String subType)` Retrieve an Access Rights policy or exception.
`MetaData`	`getSharedMDByMid(java.lang.String pdsHandle, java.lang.String mid)` Retrieve an Access Rights policy or exception by its mid.
`java.util.List<MetaData>`	`getSharedMDByType(java.lang.String pdsHandle, java.lang.String type, java.lang.String subType)` Retrieves all Access Rights policies or exceptions.
`IEStatusInfo`	`manageIE(java.lang.String pdsHandle, java.lang.String iePid, com.exlibris.core.sdk.consts.Enum.Action action)`
`void`	`unassignCMS(java.lang.String pdsHandle, java.lang.String pid, java.lang.Boolean commit)` This method unassigns CMS record from an IE, if attached
`void`	`unassignSharedMD(java.lang.String pdsHandle, java.lang.String pid, java.lang.String mid, java.lang.Boolean commit)` Unassign an Access Rights policy or exception.
`java.lang.String`	`updateDNX(java.lang.String pdsHandle, java.lang.String pid, java.lang.String content, java.lang.Boolean commit)` API for updating the DNX MD on a IE, REP or File.
`void`	`updateIEMD(java.lang.String pdsHandle, java.lang.String iePID, MetaData[] metadata)` Deprecated.
`void`	`updateMD(java.lang.String pdsHandle, java.lang.String pid, MetaData[] metadata, java.lang.Boolean commit)` API for updating the MD on a IE, REP or File.
`long`	`updateRepresentation(java.lang.String pdsHandle, java.lang.String iePid, java.lang.String repPid, java.lang.String submissionReason, RepresentationContent[] representationContent, MetaData[] metadata, java.lang.Boolean commit)` This method updates an existing representation, according to the given RepresentationContent objects list.
`void`	`updateSharedMD(java.lang.String pdsHandle, MetaData metadata)` Update an existing Access Rights policy or exception.

Methods inherited from interface com.exlibris.core.infra.svc.api.GenericWebService
getHeartBit

Method Detail

getIEMD

@Deprecated
java.lang.String getIEMD(java.lang.String pdsHandle,
                                     java.lang.String iePID)
                              throws NotInPermanentException,
                                     UserAuthorizeException,
                                     IEWSException

Deprecated.

Throws:: NotInPermanentException; UserAuthorizeException; IEWSException

getMD
```
java.lang.String getMD(java.lang.String pdsHandle,
                       java.lang.String pid,
                       java.lang.String mid,
                       java.lang.String type,
                       java.lang.String subType)
                throws NotInPermanentException,
                       UserAuthorizeException,
                       IEWSException
```
API for getting the MD of an IE , REP or File, Only MD on entity level (which is in Permanent) is returned.
The ID of the source MD section is the mid (saved in Rosetta DB)
No parameters - return all PID's MDs
MID - return matching MD (ignore type, subtype if provided)
type (only) - return all matching for type
type+subType - return all matching for type+subtype
subType (only) - not supported
type+subType mismatch - error

Supported type:subType pairs:
descriptive: dc
source: marc, dc, mods, text_md, image_niso,video_md, audio_md, copyrights, rights, other, ead, OTHER:article
mets_section: structMap
Requests by users other than the locking agent will return a response with the latest committed version.

Parameters:

pdsHandle -

PID -

mid -

type -

subType -

Returns:

Throws:

NotInPermanentException

UserAuthorizeException

IEWSException

getDNX

java.lang.String getDNX(java.lang.String pdsHandle,
                        java.lang.String pid,
                        java.lang.String section)
                 throws NotInPermanentException,
                        UserAuthorizeException,
                        IEWSException

API for getting the DNX MD of an IE , REP or File, Only MD on entity level (which is in Permanent) is returned.

Parameters:: pdsHandle -; PID -; section -
Returns:
Throws:: NotInPermanentException; UserAuthorizeException; IEWSException

updateIEMD

@Deprecated
void updateIEMD(java.lang.String pdsHandle,
                            java.lang.String iePID,
                            MetaData[] metadata)
                     throws UserAuthorizeException,
                            NotInPermanentException,
                            InvalidMIDException,
                            InvalidTypeException,
                            InvalidXmlException,
                            LockedIeException,
                            IEWSException

Deprecated.

Throws:: UserAuthorizeException; NotInPermanentException; InvalidMIDException; InvalidTypeException; InvalidXmlException; LockedIeException; IEWSException

updateMD

void updateMD(java.lang.String pdsHandle,
              java.lang.String pid,
              MetaData[] metadata,
              java.lang.Boolean commit)
       throws UserAuthorizeException,
              NotInPermanentException,
              InvalidMIDException,
              InvalidTypeException,
              InvalidXmlException,
              LockedIeException,
              IEWSException

API for updating the MD on a IE, REP or File. Request will be ignored if submitted MD is identical to existing.

Parameters:: pdsHandle -; pid -; metadata - type, subType parameters (and valid values) - mandatory mid - optional, if provided mid will be updated
Throws:: UserAuthorizeException; NotInPermanentException; InvalidMIDException; InvalidTypeException; InvalidXmlException; LockedIeException; IEWSException; java.lang.Exception

updateDNX

java.lang.String updateDNX(java.lang.String pdsHandle,
                           java.lang.String pid,
                           java.lang.String content,
                           java.lang.Boolean commit)
                    throws UserAuthorizeException,
                           NotInPermanentException,
                           InvalidMIDException,
                           InvalidTypeException,
                           InvalidXmlException,
                           LockedIeException,
                           IEWSException

API for updating the DNX MD on a IE, REP or File. Request will be ignored if submitted MD is identical to existing.
Read-only fields are ignored; refer to Rosetta AIP Data Model document for details.

Parameters:: pdsHandle -; pid -; content -
Returns:
Throws:: UserAuthorizeException; NotInPermanentException; InvalidMIDException; InvalidTypeException; InvalidXmlException; LockedIeException; IEWSException; java.lang.Exception

generateFixityEvent

void generateFixityEvent(java.lang.String PDShandle,
                         FixityEvent event,
                         java.lang.Boolean commit)
                  throws UserAuthorizeException,
                         FixityEventException,
                         LockedIeException

This method sends a fixity event for Rosetta to process.
The Event Handler in Rosetta determines whether the event is a provenance event or only a statistics event.

Parameters:: PDShandle -; event - a FixityEvent object
Throws:: UserAuthorizeException; FixityEventException; java.lang.Exception; LockedIeException

getRipStatus
```
java.lang.String getRipStatus(java.lang.String pdsHandle,
                              java.lang.Long ripID)
                       throws UserAuthorizeException,
                              IEWSException
```
Returns the current status of the given rip, can be one of the following: Finished, In Process - {stage}, In TA - {stage}. Stage is Loading, Validation, Enrichment...

Parameters:

pdsHandle -

ripID -

Returns:

the status of the rip

Throws:

UserAuthorizeException

IEWSException

getRipStatusInfo
```
RIPStatusInfo getRipStatusInfo(java.lang.String pdsHandle,
                               java.lang.Long ripID)
                        throws UserAuthorizeException,
                               IEWSException
```
Return RIPStatusInfo object.
Parameters:

pdsHandle -

ripID - Rip Registry Id

Returns:
RIPStatusInfo
- status : In Process - {stage}, In TA - {stage} or Finished, when stage can be : Loading, Validation, ByteStream or Enrichment. Similar to getRipStatus(java.lang.String, java.lang.Long) result.
- repPid : May not be available when RIP status is "In Process - Loading"
Throws:

UserAuthorizeException

IEWSException

getIE
```
java.lang.String getIE(java.lang.String pdsHandle,
                       java.lang.String iePid,
                       java.lang.Long flags)
                throws UserAuthorizeException,
                       IEWSException
```
Returns the METS of the IE.

Parameters:

flags -
0 - current IE version, including reps and files without derivative copy representations
1 - include all revisions and not just the latest (deprecated)
2 - exclude the files
4 - enrich with shared CMS metadata
8 - enrich with shared access rights metadata
16 - include minimal file information (file size, mimetype and FLocat)
32 - current IE version, including reps and files with derivative copy representations

pdsHandle - the pds handle

iePid - the ie pid

Returns:

the METS of the IE

Throws:

UserAuthorizeException

IEWSException

getIERepresentations

java.lang.String getIERepresentations(java.lang.String pdsHandle,
                                      java.lang.String iePid,
                                      java.lang.String preservationType)
                               throws UserAuthorizeException,
                                      IEWSException

Returns the Reps of the IE.

Parameters:: preservationType - support multiple preservation types, separated by semicolon (";"); pdsHandle - the pds handle; iePid - the ie pid
Returns:
Throws:: UserAuthorizeException; IEWSException

addRepresentation

long addRepresentation(java.lang.String pdsHandle,
                       java.lang.String iePid,
                       java.lang.String preservationType,
                       java.lang.String label,
                       java.lang.String representationEntityType,
                       java.lang.String representationCode,
                       java.lang.String arPolicyID,
                       java.lang.String submissionReason,
                       RepresentationContent[] representationContent,
                       MetaData[] metadata,
                       java.lang.Boolean commit)
                throws UserAuthorizeException,
                       LockedIeException,
                       FixityEventException,
                       NotInPermanentException,
                       IEWSException,
                       InvalidMIDException,
                       InvalidTypeException,
                       InvalidXmlException

This method adds new representation, according to the given representationContent objects list. Use getRipStatusInfo(String, Long) to retrieve status and the new representation Pid.

Parameters:: pdsHandle -; iePid - The IE under which this representation would be added; preservationType - Code from the "Preservation Type" code table; label - A label for the new representation; representationEntityType - Code from the "Representation Entity Type" code table; representationCode - Code from the "RepresentationCode" code table; arPolicyID - Mid of the access right policy assigned to the new representation; submissionReason - The submission reason for the update; representationContent - List of RepresentationContent objects which represents the files of the new representation. oldFilePid and operation fields aren't relevant in the addRepresentation case.; metadata - list of metadata for this representation. structmap (logical only) can be added only using updateMetadata.
Returns:: Rip Registry ID
Throws:: UserAuthorizeException; LockedIeException; FixityEventException; NotInPermanentException; IEWSException; InvalidMIDException; InvalidTypeException; InvalidXmlException

updateRepresentation

long updateRepresentation(java.lang.String pdsHandle,
                          java.lang.String iePid,
                          java.lang.String repPid,
                          java.lang.String submissionReason,
                          RepresentationContent[] representationContent,
                          MetaData[] metadata,
                          java.lang.Boolean commit)
                   throws UserAuthorizeException,
                          LockedIeException,
                          FixityEventException,
                          NotInPermanentException,
                          IEWSException,
                          InvalidMIDException,
                          InvalidTypeException,
                          InvalidXmlException

This method updates an existing representation, according to the given RepresentationContent objects list.

Parameters:: pdsHandle -; iePid - The IE under which this representation would be updated; repPid - The representation which is updated; submissionReason - The submission reason for the update; representationContent - A RepresentationContent object. Represents the updated content (i.e. the difference between the existing Rep, file-wise); metadata - list of metadata for this representation. structmap (logical only) can be added only using updateMetadata.
Returns:: The rip registry ID.
Throws:: UserAuthorizeException; LockedIeException; IEWSException; NotInPermanentException; FixityEventException; InvalidXmlException; InvalidTypeException; InvalidMIDException; java.lang.Exception

createSharedMD

java.lang.String createSharedMD(java.lang.String pdsHandle,
                                MetaData metadata)
                         throws UserAuthorizeException,
                                InvalidTypeException,
                                InvalidXmlException,
                                IEWSException

Creates a new Access Rights policy or exception.

Parameters:: pdsHandle -; metadata - - metadata.content = Access Rights XML, metdata.mid - (null) , metadata.subType = accessrights, metadata.type = policy|local.
Returns:
Throws:: UserAuthorizeException; InvalidTypeException; InvalidXmlException; IEWSException

updateSharedMD

void updateSharedMD(java.lang.String pdsHandle,
                    MetaData metadata)
             throws UserAuthorizeException,
                    InvalidTypeException,
                    InvalidMIDException,
                    IEWSException,
                    InvalidXmlException

Update an existing Access Rights policy or exception.

Parameters:: pdsHandle -; metadata - - metadata.content = Access Rights XML, metdata.mid = Existing Access Rights MD id , metadata.subType - (null), metadata.type = (null).
Throws:: UserAuthorizeException; InvalidTypeException; InvalidMIDException; java.lang.Exception; IEWSException; InvalidXmlException

deleteSharedMD

void deleteSharedMD(java.lang.String pdsHandle,
                    java.lang.String mid)
             throws UserAuthorizeException,
                    InvalidMIDException

Delete an (unassigned) Access Rights policy or exception

Parameters:: pdsHandle -; mid - = Existing Access Rights MD id
Throws:: UserAuthorizeException; InvalidMIDException

getSharedMD

java.util.List<MetaData> getSharedMD(java.lang.String pdsHandle,
                                     java.lang.String pid,
                                     java.lang.String type,
                                     java.lang.String subType)
                              throws UserAuthorizeException,
                                     IEWSException

Retrieve an Access Rights policy or exception. If type is null will retrieve both.

Parameters:: pdsHandle -; pid - = IE or REP pid from permanent; type - = policy|local|(null); subType - = accessrights
Returns:
Throws:: UserAuthorizeException; InvalidMIDException; IEWSException

getSharedMDByType

java.util.List<MetaData> getSharedMDByType(java.lang.String pdsHandle,
                                           java.lang.String type,
                                           java.lang.String subType)
                                    throws UserAuthorizeException,
                                           IEWSException

Retrieves all Access Rights policies or exceptions. If type is null will retrieve both.

Parameters:: pdsHandle -; type - = policy|local|(null); subType - = accessrights
Returns:
Throws:: UserAuthorizeException; InvalidMIDException; IEWSException

getSharedMDByMid

MetaData getSharedMDByMid(java.lang.String pdsHandle,
                          java.lang.String mid)
                   throws UserAuthorizeException,
                          InvalidMIDException

Retrieve an Access Rights policy or exception by its mid.

Parameters:: pdsHandle -; mid - - Existing Access Rights mid.
Returns:
Throws:: UserAuthorizeException; InvalidMIDException

assignSharedMD

void assignSharedMD(java.lang.String pdsHandle,
                    java.lang.String pid,
                    java.lang.String mid,
                    java.lang.Boolean commit)
             throws UserAuthorizeException,
                    InvalidMIDException,
                    NotInPermanentException,
                    LockedIeException,
                    IEWSException

Assign an Access Rights policy or exception.

Parameters:: pdsHandle -; pid - - IE or REP unlocked pid from permanent; mid - - Existing Access Rights mid.
Throws:: UserAuthorizeException; InvalidMIDException; NotInPermanentException; LockedIeException; IEWSException

unassignSharedMD

void unassignSharedMD(java.lang.String pdsHandle,
                      java.lang.String pid,
                      java.lang.String mid,
                      java.lang.Boolean commit)
               throws UserAuthorizeException,
                      InvalidMIDException,
                      NotInPermanentException,
                      LockedIeException,
                      IEWSException

Unassign an Access Rights policy or exception.

Parameters:: pdsHandle -; pid - - IE or REP pid from permanent; mid - - Existing Access Rights mid. Policy can only be unassigned from a REP pid.
Throws:: UserAuthorizeException; InvalidMIDException; NotInPermanentException; LockedIeException; IEWSException

manageIE

IEStatusInfo manageIE(java.lang.String pdsHandle,
                      java.lang.String iePid,
                      com.exlibris.core.sdk.consts.Enum.Action action)
               throws UserAuthorizeException,
                      NotInPermanentException,
                      IEWSException,
                      LockedIeException

Parameters:: pdsHandle - - the pds handle.; iePid - - IE pid from permanent.; Action - - one of the following values: INFO, LOCK, OVERRIDELOCK, COMMIT, ROLLBACK
Throws:: UserAuthorizeException; NotInPermanentException; IEWSException; LockedIeException

assignCMS

void assignCMS(java.lang.String pdsHandle,
               java.lang.String pid,
               java.lang.String cmsSystem,
               java.lang.String cmsRecordId,
               java.lang.Boolean commit)
        throws InvalidTypeException,
               NotInPermanentException,
               UserAuthorizeException,
               LockedIeException,
               InvalidCMSSystemException,
               IEWSException

This method assigns CMS record to an IE, according to the given cmsSystem/cmsRecordId parameters

Parameters:: pdsHandle -; pid - IE pid from permanent; cmsSystem - CMS System which defined in the external_resource_explorer_configuration.xml configuration file; cmsRecordId - CMS Record Id; commit - whether to commit changes or not
Throws:: InvalidTypeException; NotInPermanentException; UserAuthorizeException; LockedIeException; InvalidCMSSystemException; IEWSException

unassignCMS

void unassignCMS(java.lang.String pdsHandle,
                 java.lang.String pid,
                 java.lang.Boolean commit)
          throws InvalidTypeException,
                 NotInPermanentException,
                 UserAuthorizeException,
                 LockedIeException,
                 IEWSException

This method unassigns CMS record from an IE, if attached

Parameters:: pdsHandle -; pid - IE pid from permanent; commit - whether to commit changes or not
Throws:: InvalidTypeException; NotInPermanentException; UserAuthorizeException; LockedIeException; IEWSException

Interface IEWebServices