com.yourmediashelf.fedora.client.messaging

Class AtomApimMessage

java.lang.Object

com.yourmediashelf.fedora.client.messaging.AtomApimMessage

All Implemented Interfaces:

ApimMessage, FedoraMessage

public class AtomApimMessage
extends Object
implements ApimMessage

Representation of an API-M method call as an Atom entry.

• atom:title corresponds to the method name, e.g. ingest
• Each atom:category corresponds to a method's argument:
  • The scheme indicates the argument name
  • The term indicates the argument value. However, null values are indicated as "null", and non-null xsd:base64Binary values are indicated as "[OMITTED]".
  • The label indicates the argument datatype
• atom:content corresponds to the textual representation of the method's return value, noting the following:
  • Null values are represented as "null".
  • fedora-types:ArrayOfString values are represented as a comma-separated list, e.g. "value1, value2, value3".
  • Non-null xsd:base64Binary values are not returned, and only indicated as "[OMITTED]".
  • Non-null fedora-types:Datastream values are not returned, and only indicated as "[OMITTED]".
  • fedora-types:RelationshipTuple values are represented in Notation3 (N3).
• atom:uri element of atom:author corresponds to the baseURL of the Fedora repository, e.g. http://localhost:8080/fedora.
• atom:summary corresponds to the PID of the method, if applicable.

Author:

Edwin Shin

See Also:

The Atom Syndication Format

Constructor Summary

Constructors

Constructor and Description
AtomApimMessage(String messageText)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAuthor()
String	getBaseUrl()
Date	getDate()
String	getFormat() An identifier for the serialization format of the message.
String	getMethodName()
String	getMethodParamVal(String paramName)
String	getPID()
String	getReturnVal()
String	getServerVersion() Version of the Fedora server that produced the message (version.major + version.minor), e.g.
String	toString() Serialization of the API-M message as an Atom entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

AtomApimMessage

public AtomApimMessage(String messageText)

Method Detail

toString

public String toString()

Serialization of the API-M message as an Atom entry.

Overrides:

toString in class Object

getBaseUrl

public String getBaseUrl()

Specified by:

getBaseUrl in interface ApimMessage

Returns:

the Base URL of the Fedora Repository that generated the message, e.g. http://localhost:8080/fedora

getDate

public Date getDate()

Specified by:

getDate in interface ApimMessage

Returns:

the Date object representing the timestamp of the method call

getMethodName

public String getMethodName()

Specified by:

getMethodName in interface ApimMessage

Returns:

the name of the API-M method invoked

getPID

public String getPID()

Specified by:

getPID in interface ApimMessage

Returns:

the PID or null if not applicable for the API-M method

getAuthor

public String getAuthor()

getFormat

public String getFormat()

Description copied from interface: FedoraMessage

An identifier for the serialization format of the message.

Specified by:

getFormat in interface FedoraMessage

Returns:

the identifier for the message format serialization (e.g. info:fedora/fedora-system:ATOM-APIM-1.0)

getServerVersion

public String getServerVersion()

Description copied from interface: FedoraMessage

Version of the Fedora server that produced the message (version.major + version.minor), e.g. 3.0b2. Messages generated by clients should return the version of the Fedora server the message is intended for.

Specified by:

getServerVersion in interface FedoraMessage

Returns:

Fedora server version

getReturnVal

public String getReturnVal()

Specified by:

getReturnVal in interface ApimMessage

Returns:

the return value of the API-M method invoked

getMethodParamVal

public String getMethodParamVal(String paramName)

Specified by:

getMethodParamVal in interface ApimMessage

Returns:

the value (as a string) of the parameter of the API-M method invoked. Return null if parameter not present.