Package com.isode.dsapi.syntax

Class MOSAP

java.lang.Object

com.isode.dsapi.syntax.MOSAP

All Implemented Interfaces:

Comparable<MOSAP>

public class MOSAP
extends Object
implements Comparable<MOSAP>

This class stores information about a MOSAP.

This is an immutable class.

Examples:

master#ou=System,o=Isode#URI+1+URL+ldap://localhost

shadow#cn=DSA,ou=System,o=Isode#TELEX+00728722+IP-APP+11+127.0.0.1

Since:

15.0

Author:

mv

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MOSAP.Category	An enumeration defining the different categories that can be used to create a MOSAP.

Constructor Summary

Constructors

Constructor	Description
MOSAP(AccessPoint ap, MOSAP.Category category)	Constructor to create an object with the given data.
MOSAP(String str)	Constructor to create an object with the given data.

Method Summary

Modifier and Type	Method	Description
int	compareTo(MOSAP o)	see Comparable.compareTo(Object)
boolean	equals(Object other)
AccessPoint	getAccessPoint()
MOSAP	getCanonicalForm()	The access point is converted to its canonical form.
MOSAP.Category	getCategory()
MOSAP	getUnusableCanonicalForm()	The access point is converted to its canonical form.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MOSAP

public MOSAP(String str)
      throws BadValueException,
BadSyntaxException

Constructor to create an object with the given data.

Parameters:

str - String representation. This must never be null.

Throws:

BadValueException - if the input is invalid.

BadSyntaxException - if it is not possible to parse AccessPoint or PresentationAddress objects in this environment.

MOSAP

public MOSAP(AccessPoint ap,
 MOSAP.Category category)
      throws BadValueException

Constructor to create an object with the given data.

Parameters:

ap - Access point. This must never be null.

category - Category. This must never be null.

Throws:

BadValueException - if any input is null.

Method Details

toString

public String toString()

Overrides:

toString in class Object

getAccessPoint

public AccessPoint getAccessPoint()

Returns:

Access point. This will never be null.

getCategory

public MOSAP.Category getCategory()

Returns:

Category. This will never be null.

getCanonicalForm

public MOSAP getCanonicalForm()
                       throws BadSyntaxException

The access point is converted to its canonical form.

Returns:

canonical form of object.

Throws:

BadSyntaxException - if it is not possible to parse the presentation address.

getUnusableCanonicalForm

public MOSAP getUnusableCanonicalForm()

The access point is converted to its canonical form. However, the ASN value of access point is not assigned. As a result, this form can not be used for any external operations. This method should only be used by classes that need the canonical form without any exceptions, e.g. in the implementation of hashCode(), compareTo(MOSAP)

Returns:

canonical form of object.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(MOSAP o)

see Comparable.compareTo(Object)

Specified by:

compareTo in interface Comparable<MOSAP>