Module jcifs

Package org.codelibs.jcifs.smb.ntlmssp

Class NtlmMessage

java.lang.Object

org.codelibs.jcifs.smb.ntlmssp.NtlmMessage

All Implemented Interfaces:

NtlmFlags

Direct Known Subclasses:

Type1Message, Type2Message, Type3Message

public abstract class NtlmMessage
extends Object
implements NtlmFlags

Abstract superclass for all NTLMSSP messages.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final byte[]	NTLMSSP_SIGNATURE	The NTLMSSP "preamble".
protected static final int	NTLMSSP_TYPE1	NTLMSSP Type 1 message identifier.
protected static final int	NTLMSSP_TYPE2	NTLMSSP Type 2 message identifier.
protected static final int	NTLMSSP_TYPE3	NTLMSSP Type 3 message identifier.
protected static final byte[]	NTLMSSP_VERSION	NTLM version
protected static final String	UNI_ENCODING	Unicode encoding used for NTLM messages.

Fields inherited from interface org.codelibs.jcifs.smb.ntlmssp.NtlmFlags

NTLMSSP_NEGOTIATE_128, NTLMSSP_NEGOTIATE_56, NTLMSSP_NEGOTIATE_ALWAYS_SIGN, NTLMSSP_NEGOTIATE_ANONYMOUS, NTLMSSP_NEGOTIATE_DATAGRAM_STYLE, NTLMSSP_NEGOTIATE_EXTENDED_SESSIONSECURITY, NTLMSSP_NEGOTIATE_KEY_EXCH, NTLMSSP_NEGOTIATE_LM_KEY, NTLMSSP_NEGOTIATE_LOCAL_CALL, NTLMSSP_NEGOTIATE_NETWARE, NTLMSSP_NEGOTIATE_NTLM, NTLMSSP_NEGOTIATE_OEM, NTLMSSP_NEGOTIATE_OEM_DOMAIN_SUPPLIED, NTLMSSP_NEGOTIATE_OEM_WORKSTATION_SUPPLIED, NTLMSSP_NEGOTIATE_SEAL, NTLMSSP_NEGOTIATE_SIGN, NTLMSSP_NEGOTIATE_TARGET_INFO, NTLMSSP_NEGOTIATE_UNICODE, NTLMSSP_NEGOTIATE_VERSION, NTLMSSP_REQUEST_ACCEPT_RESPONSE, NTLMSSP_REQUEST_INIT_RESPONSE, NTLMSSP_REQUEST_NON_NT_SESSION_KEY, NTLMSSP_REQUEST_TARGET, NTLMSSP_TARGET_TYPE_DOMAIN, NTLMSSP_TARGET_TYPE_SERVER, NTLMSSP_TARGET_TYPE_SHARE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NtlmMessage()	Default constructor.

Method Summary

Modifier and Type	Method	Description
boolean	getFlag(int flag)	Returns the status of the specified flag.
int	getFlags()	Returns the flags currently in use for this message.
void	setFlag(int flag, boolean value)	Sets or clears the specified flag.
void	setFlags(int flags)	Sets the flags for this message.
abstract byte[]	toByteArray()	Returns the raw byte representation of this message.

Methods inherited from class java.lang.Object

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

Field Details

NTLMSSP_SIGNATURE

protected static final byte[] NTLMSSP_SIGNATURE

The NTLMSSP "preamble".

NTLMSSP_VERSION

protected static final byte[] NTLMSSP_VERSION

NTLM version

NTLMSSP_TYPE1

protected static final int NTLMSSP_TYPE1

NTLMSSP Type 1 message identifier.

See Also:

• Constant Field Values

NTLMSSP_TYPE2

protected static final int NTLMSSP_TYPE2

NTLMSSP Type 2 message identifier.

See Also:

• Constant Field Values

NTLMSSP_TYPE3

protected static final int NTLMSSP_TYPE3

NTLMSSP Type 3 message identifier.

See Also:

• Constant Field Values

UNI_ENCODING

protected static final String UNI_ENCODING

Unicode encoding used for NTLM messages.

See Also:

• Constant Field Values

Constructor Details

NtlmMessage

protected NtlmMessage()

Default constructor.

Method Details

getFlags

public int getFlags()

Returns the flags currently in use for this message.

Returns:

An int containing the flags in use for this message.

setFlags

public void setFlags(int flags)

Sets the flags for this message.

Parameters:

flags - The flags for this message.

getFlag

public boolean getFlag(int flag)

Returns the status of the specified flag.

Parameters:

flag - The flag to test (i.e., NTLMSSP_NEGOTIATE_OEM).

Returns:

A boolean indicating whether the flag is set.

setFlag

public void setFlag(int flag,
 boolean value)

Sets or clears the specified flag.

Parameters:

flag - The flag to set/clear (i.e., NTLMSSP_NEGOTIATE_OEM).

value - Indicates whether to set (true) or clear (false) the specified flag.

toByteArray

public abstract byte[] toByteArray()
                            throws IOException

Returns the raw byte representation of this message.

Returns:

A byte[] containing the raw message material.

Throws:

IOException - if an error occurs during message serialization