net.geant.edugain.meta.metadata
Class HomeLocator

java.lang.Object
  net.geant.edugain.meta.metadata.HomeLocator

public class HomeLocator
extends java.lang.Object

This class contains a representation of an eduGAIN Home Locator, used for issuing more specific metadata queries

Author:

Manuela Stanica

Field Summary

static java.lang.String	HOME_DOMAIN homeDomain value of the Home Locator name
private java.lang.String	name Name of the home locator
static java.lang.String	NET_ID netID value of the Home Locator name
static java.lang.String	URN URN value of the Home Locator name
private java.lang.String	value Value of the home locator

Constructor Summary

HomeLocator()
Constructor

HomeLocator(java.lang.String name, java.lang.String val)
Constructor, takes as parameters the name and value of the HL.

Method Summary

boolean	equals(java.lang.Object locator) Compare HomeLocators.
java.lang.String	getName() Gets the name of the home locator
java.lang.String	getValue() Gets the value of the home locator
int	hashCode() Get the hash code of this object.
void	setHomeDomainHL(java.lang.String val) Sets the HL name to HOME_DOMAIN, with the given value
void	setNetIdHL(java.lang.String val) Sets the HL name to NET_ID, with the given value
void	setURNHL(java.lang.String val) Sets the HL name to URN, with the given value

Methods inherited from class java.lang.Object

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

Field Detail

name

private java.lang.String name

Name of the home locator

value

private java.lang.String value

Value of the home locator

HOME_DOMAIN

public static final java.lang.String HOME_DOMAIN

homeDomain value of the Home Locator name

See Also:

Constant Field Values

NET_ID

public static final java.lang.String NET_ID

netID value of the Home Locator name

See Also:

Constant Field Values

URN

public static final java.lang.String URN

URN value of the Home Locator name

See Also:

Constant Field Values

Constructor Detail

HomeLocator

public HomeLocator()

Constructor

HomeLocator

public HomeLocator(java.lang.String name,
                   java.lang.String val)
            throws MetaQueryException

Constructor, takes as parameters the name and value of the HL. The name parameter must be one of the supported types of HLs (represented by the static attributes HOME_DOMAIN, NET_ID or URN).

Parameters:

name -

val -

Throws:

MetaQueryException - if the name parameter is not a supported HL

Method Detail

setHomeDomainHL

public void setHomeDomainHL(java.lang.String val)

Sets the HL name to HOME_DOMAIN, with the given value

Parameters:

val - the value of the Home Domain HL

setNetIdHL

public void setNetIdHL(java.lang.String val)

Sets the HL name to NET_ID, with the given value

Parameters:

val - the value of the Net Id HL

setURNHL

public void setURNHL(java.lang.String val)

Sets the HL name to URN, with the given value

Parameters:

val - the value of the Urn HL

getName

public java.lang.String getName()

Gets the name of the home locator

Returns:

the name of the home locator

getValue

public java.lang.String getValue()

Gets the value of the home locator

Returns:

the value of the home locator

equals

public boolean equals(java.lang.Object locator)

Compare HomeLocators.

Overrides:

equals in class java.lang.Object

Parameters:

locator - The locator

Returns:

True if the locator is the same, else false.

hashCode

public int hashCode()

Get the hash code of this object.

Overrides:

hashCode in class java.lang.Object

Returns:

The hash code associated with this object.