au.csiro.pidclient.business
Class AndsPidIdentity

java.lang.Object
  au.csiro.pidclient.business.AndsPidIdentity

public class AndsPidIdentity
extends Object

Represents the identify information required when calling the ANDS Persistent Identifier service. Copyright 2010, CSIRO Australia All rights reserved.

Version:

$Revision: 7131 $ $Date: 2010-06-09 14:25:15 +1000 (Wed, 09 Jun 2010) $

Author:

Robert Bridle on 08/02/2010

Constructor Summary

AndsPidIdentity()

AndsPidIdentity(String appId, String identifier, String authDomain)
Constructor

Method Summary

String	escape(String in) Escape reserved characters, assumes UTF-8 or UTF-16 as encoding.
String	getAppId()
String	getAuthDomain()
String	getIdentifier()
void	setAppId(String appId)
void	setAuthDomain(String authDomain)
void	setIdentifier(String identifier)
String	toString()
String	toXML(String methodName) Formats the identity information into a XML format that the ANDS Persistent Identifier service understands.

Methods inherited from class java.lang.Object

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

Constructor Detail

AndsPidIdentity

public AndsPidIdentity()

AndsPidIdentity

public AndsPidIdentity(String appId,
                       String identifier,
                       String authDomain)

Constructor

Parameters:

appId - the unique Id provided to the caller upon IP registration with the ANDS Persistent Identifier service.

identifier - the identifier or name of the repository calling the service.

authDomain - the domain of the organisation calling the service.

Method Detail

getAppId

public String getAppId()

Returns:

the appId

setAppId

public void setAppId(String appId)

Parameters:

appId - the appId to set

getIdentifier

public String getIdentifier()

Returns:

the identifier

setIdentifier

public void setIdentifier(String identifier)

Parameters:

identifier - the identifier to set

getAuthDomain

public String getAuthDomain()

Returns:

the authDomain

setAuthDomain

public void setAuthDomain(String authDomain)

Parameters:

authDomain - the authDomain to set

toXML

public String toXML(String methodName)

Formats the identity information into a XML format that the ANDS Persistent Identifier service understands.

Parameters:

methodName - the name of the method to be called using this identity information.

Returns:

the identity XML string representing the identity information.

toString

public String toString()

Overrides:

toString in class Object

escape

public String escape(String in)

Escape reserved characters, assumes UTF-8 or UTF-16 as encoding.

Parameters:

in - the String whose reserved characters we want to remove.

Returns:

the in String, stripped of reserved characters.