Package com.iplanet.services.naming.share

Class NamingRequest

java.lang.Object

com.iplanet.services.naming.share.NamingRequest

public class NamingRequest
extends Object

This NamingRequest class represents a NamingRequest XML document. The NamingRequest DTD is defined as the following:

     <?xml version="1.0">
     < !DOCTYPE NamingRequest [
     < !ELEMENT NamingRequest (GetNamingProfile)>
     < !ATTLIST NamingRequest
       vers   CDATA #REQUIRED
       reqid  CDATA #REQUIRED
       sessid CDATA #REQUIRED>
     < !ELEMENT GetNamingProfile EMPTY>
     ]>
 

Field Summary

Fields

Modifier and Type	Field	Description
static String	reqVersion

Constructor Summary

Constructors

Constructor	Description
NamingRequest(String ver)	This constructor shall only be used at the client side to construct a NamingRequest object.

Method Summary

Modifier and Type	Method	Description
String	getPreferredNamingURL()	Gets the PreferredNamingURL.
String	getRequestID()	Gets the request ID.
String	getRequestVersion()	Gets the request version.
String	getSessionId()	Gets the session ID.
static NamingRequest	parseXML(String xml)	This method is used primarily at the server side to reconstruct a NamingRequest object based on the XML document received from client.
void	setPreferredNamingURL(String url)	Sets the PreferredNamingURL.
void	setRequestID(String id)	Sets the request ID.
void	setRequestVersion(String version)	Sets the request version.
void	setSessionId(String id)	Sets the session ID.
String	toXMLString()	This method translates the request to an XML document String based on the NamingRequest DTD described above.

Methods inherited from class java.lang.Object

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

Field Detail

reqVersion

public static final String reqVersion

See Also:

Constant Field Values

Constructor Detail

NamingRequest

public NamingRequest(String ver)

This constructor shall only be used at the client side to construct a NamingRequest object.

Parameters:

ver - The naming request version.

Method Detail

parseXML

public static NamingRequest parseXML(String xml)

This method is used primarily at the server side to reconstruct a NamingRequest object based on the XML document received from client. The DTD of this XML document is described above.

Parameters:

xml - The NamingRequest XML document String.

Returns:

NamingRequest object.

setRequestVersion

public void setRequestVersion(String version)

Sets the request version.

Parameters:

version - A string representing the request version.

getRequestVersion

public String getRequestVersion()

Gets the request version.

Returns:

The request version.

setRequestID

public void setRequestID(String id)

Sets the request ID.

Parameters:

id - A string representing the request ID.

getRequestID

public String getRequestID()

Gets the request ID.

Returns:

The request ID.

setSessionId

public void setSessionId(String id)

Sets the session ID.

Parameters:

id - A string representing the session ID.

getSessionId

public String getSessionId()

Gets the session ID.

Returns:

The session ID.

setPreferredNamingURL

public void setPreferredNamingURL(String url)

Sets the PreferredNamingURL.

Parameters:

url - A string representing preferred NamingURL by client.

getPreferredNamingURL

public String getPreferredNamingURL()

Gets the PreferredNamingURL.

Returns:

The PreferredNamingURL.

toXMLString

public String toXMLString()

This method translates the request to an XML document String based on the NamingRequest DTD described above.

Returns:

An XML String representing the request.