jreceiver.common.rec.security
Class MethodKey

java.lang.Object
  |
  +--jreceiver.common.rec.BaseRec
        |
        +--jreceiver.common.rec.security.MethodKey

All Implemented Interfaces:

java.lang.Comparable, Hashable, Key

public class MethodKey

extends BaseRec

implements Key, java.lang.Comparable

An interface representing a single master/slave binding key

Version:

$Revision: 1.1 $ $Date: 2002/07/20 01:42:18 $

Author:

Reed Esau

Field Summary

static java.lang.String	HKEY_HANDLER_NAME
static java.lang.String	HKEY_METHOD_NAME

Constructor Summary

MethodKey()
ctor - default

MethodKey(java.util.Hashtable hash)
ctor - construct from a hashtable, usually retrieved via XML-RPC

MethodKey(java.lang.String handler_name, java.lang.String method_name)
ctor - shallow

Method Summary

int	compareTo(java.lang.Object obj) Compares this object with the specified object for order.
static MethodKey	createFromFormattedKey(java.lang.String formatted_key) create a new MethodKey object from a formatted method key String
boolean	equals(java.lang.Object obj) Indicates whether some other object is "equal to" this one.
java.lang.String	getFormattedKey() obtain the key, formatted as "handler_name.method_name"
java.lang.String	getHandlerName()
boolean	getIsValid() return true if the key is sound
java.lang.String	getMethodName()
java.util.Map	getParams() return the url parameters necessary to identify this rec by key
int	hashCode() Returns a hash code value for the object.
void	setHandlerName(java.lang.String handler_name)
void	setMethodName(java.lang.String method_name)
java.util.Hashtable	toHash() Store the object as a hash suitable for transport over an XML-RPC connection or similar.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class jreceiver.common.rec.BaseRec

dissolve, dissolveMap, find, find, find, find

Methods inherited from class java.lang.Object

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

Field Detail

HKEY_HANDLER_NAME

public static final java.lang.String HKEY_HANDLER_NAME

HKEY_METHOD_NAME

public static final java.lang.String HKEY_METHOD_NAME

Constructor Detail

MethodKey

public MethodKey()

ctor - default

MethodKey

public MethodKey(java.lang.String handler_name,
                 java.lang.String method_name)

ctor - shallow

MethodKey

public MethodKey(java.util.Hashtable hash)

ctor - construct from a hashtable, usually retrieved via XML-RPC

Method Detail

hashCode

public int hashCode()

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(java.lang.Object obj)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Specified by:

compareTo in interface java.lang.Comparable

getHandlerName

public java.lang.String getHandlerName()

setHandlerName

public void setHandlerName(java.lang.String handler_name)

getMethodName

public java.lang.String getMethodName()

setMethodName

public void setMethodName(java.lang.String method_name)

getFormattedKey

public java.lang.String getFormattedKey()

obtain the key, formatted as "handler_name.method_name"

createFromFormattedKey

public static MethodKey createFromFormattedKey(java.lang.String formatted_key)
                                        throws RecException

create a new MethodKey object from a formatted method key String

getIsValid

public boolean getIsValid()

return true if the key is sound

getParams

public java.util.Map getParams()

return the url parameters necessary to identify this rec by key

toString

public java.lang.String toString()

Returns a string representation of the object.

Specified by:

toString in interface Hashable

Overrides:

toString in class java.lang.Object

toHash

public java.util.Hashtable toHash()

Store the object as a hash suitable for transport over an XML-RPC connection or similar.

Use MethodRec(Hashtable) to transform the data back into an object of this type.

Specified by:

toHash in interface Hashable

Following copied from interface: jreceiver.common.rec.Hashable

Returns: