org.opennms.netmgt.config.capsd

Class SmbAuth

java.lang.Object

org.opennms.netmgt.config.capsd.SmbAuth

All Implemented Interfaces:

Serializable

public class SmbAuth
extends Object
implements Serializable

SMB authentication. SMB authentication is not required by jCIFS in order to determine the NetBIOS name for a remote host which supports SMB. However it may be required in order to enumerate the hosts's list of file shares. It is during this enumeration that we are able to determine the operating system and MAC address of the remote system. SMB URLs (for enumerating file shares) are formatted as follows: If no matching SmbAuth, object URL has format: "smb://". For server authentication, URL has format: "smb://:@". For domain authentication, URL has format: "smb://;:@"

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SmbAuth()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getContent() Returns the value of field 'content'.
String	getPassword() Returns the value of field 'password'.
String	getType() Returns the value of field 'type'.
String	getUser() Returns the value of field 'user'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setContent(String content) Sets the value of field 'content'.
void	setPassword(String password) Sets the value of field 'password'.
void	setType(String type) Sets the value of field 'type'.
void	setUser(String user) Sets the value of field 'user'.
static SmbAuth	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

SmbAuth

public SmbAuth()

Method Detail

equals

public boolean equals(Object obj)

Overrides the java.lang.Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getContent

public String getContent()

Returns the value of field 'content'. The field 'content' has the following description: internal content storage

Returns:

the value of field 'Content'.

getPassword

public String getPassword()

Returns the value of field 'password'. The field 'password' has the following description: Password

Returns:

the value of field 'Password'.

getType

public String getType()

Returns the value of field 'type'. The field 'type' has the following description: Authentication type

Returns:

the value of field 'Type'.

getUser

public String getUser()

Returns the value of field 'user'. The field 'user' has the following description: User ID

Returns:

the value of field 'User'.

hashCode

public int hashCode()

Overrides the java.lang.Object.hashCode method.

The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

setContent

public void setContent(String content)

Sets the value of field 'content'. The field 'content' has the following description: internal content storage

Parameters:

content - the value of field 'content'.

setPassword

public void setPassword(String password)

Sets the value of field 'password'. The field 'password' has the following description: Password

Parameters:

password - the value of field 'password'.

setType

public void setType(String type)

Sets the value of field 'type'. The field 'type' has the following description: Authentication type

Parameters:

type - the value of field 'type'.

setUser

public void setUser(String user)

Sets the value of field 'user'. The field 'user' has the following description: User ID

Parameters:

user - the value of field 'user'.

unmarshal

public static SmbAuth unmarshal(Reader reader)
                         throws org.exolab.castor.xml.MarshalException,
                                org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.config.capsd.SmbAuth

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema