org.alfresco.jlan.smb.mailslot

Class HostAnnouncer

java.lang.Object

java.lang.Thread

org.alfresco.jlan.smb.mailslot.HostAnnouncer

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

TcpipNetBIOSHostAnnouncer, Win32NetBIOSHostAnnouncer

public abstract class HostAnnouncer
extends java.lang.Thread

The host announcer class periodically broadcasts a host announcement datagram to inform other Windows networking hosts of the local hosts existence and capabilities.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
static int	SHUTDOWN_COUNT
static int	SHUTDOWN_WAIT
static long	STARTING_INTERVAL

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
HostAnnouncer() HostAnnouncer constructor.
HostAnnouncer(java.lang.String name, java.lang.String domain, int intval) Create a host announcer.

Method Summary

Methods

Modifier and Type	Method and Description
void	addHostName(java.lang.String name) Add a host name to the list of names to announce
void	addHostNames(StringList names) Add a list of names to the announcement list
java.lang.String	getComment() Return the server comment string.
java.lang.String	getDomain() Return the domain name that the host announcement is directed to.
java.lang.String	getHostName(int idx) Return the specified host name being announced.
int	getInterval() Return the announcement interval, in minutes.
int	getServerType() Return the server type flags.
boolean	hasDebug() Determine if debug output is enabled
protected void	initHostAnnounceSMB(java.lang.String name) Initialize the host announcement SMB.
protected abstract void	initialize() Initialize the host announcer.
abstract boolean	isNetworkEnabled() Determine if the network connection used for the host announcement is valid
int	numberOfNames() Return the number of names being announced
void	run() Start the host announcer thread.
protected abstract void	sendAnnouncement(java.lang.String hostName, byte[] buf, int offset, int len) Send an announcement broadcast.
void	setComment(java.lang.String comment) Set the server comment string.
void	setDebug(boolean dbg) Enable/disable debug output
void	setDomain(java.lang.String name) Set the domain name that the host announcement are directed to.
void	setInterval(int intval) Set the announcement interval, in minutes.
void	setServerType(int typ) Set the server type flags.
void	shutdownAnnouncer() Shutdown the host announcer and remove the announced name from Network Neighborhood.
void	startAnnouncer() Start the host announcer

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

SHUTDOWN_WAIT

public static final int SHUTDOWN_WAIT

See Also:

Constant Field Values

SHUTDOWN_COUNT

public static final int SHUTDOWN_COUNT

See Also:

Constant Field Values

STARTING_INTERVAL

public static final long STARTING_INTERVAL

See Also:

Constant Field Values

Constructor Detail

HostAnnouncer

public HostAnnouncer()

HostAnnouncer constructor.

HostAnnouncer

public HostAnnouncer(java.lang.String name,
             java.lang.String domain,
             int intval)

Create a host announcer.

Parameters:

name - Host name to announce

domain - Domain name to announce to

intval - Announcement interval, in minutes

Method Detail

getComment

public final java.lang.String getComment()

Return the server comment string.

Returns:

java.lang.String

getDomain

public final java.lang.String getDomain()

Return the domain name that the host announcement is directed to.

Returns:

java.lang.String

numberOfNames

public final int numberOfNames()

Return the number of names being announced

Returns:

int

getHostName

public final java.lang.String getHostName(int idx)

Return the specified host name being announced.

Parameters:

idx - int

Returns:

java.lang.String

getInterval

public final int getInterval()

Return the announcement interval, in minutes.

Returns:

int

getServerType

public final int getServerType()

Return the server type flags.

Returns:

int

hasDebug

public final boolean hasDebug()

Determine if debug output is enabled

Returns:

boolean

setDebug

public final void setDebug(boolean dbg)

Enable/disable debug output

Parameters:

dbg - true or false

initHostAnnounceSMB

protected final void initHostAnnounceSMB(java.lang.String name)

Initialize the host announcement SMB.

Parameters:

name - String

startAnnouncer

public final void startAnnouncer()

Start the host announcer

run

public void run()

Start the host announcer thread.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

initialize

protected abstract void initialize()
                            throws java.lang.Exception

Initialize the host announcer.

Throws:

java.lang.Exception

isNetworkEnabled

public abstract boolean isNetworkEnabled()

Determine if the network connection used for the host announcement is valid

Returns:

boolean

sendAnnouncement

protected abstract void sendAnnouncement(java.lang.String hostName,
                    byte[] buf,
                    int offset,
                    int len)
                                  throws java.lang.Exception

Send an announcement broadcast.

Parameters:

hostName - Host name being announced

buf - Buffer containing the host announcement mailslot message.

offset - Offset to the start of the host announcement message.

len - Host announcement message length.

Throws:

java.lang.Exception

setComment

public final void setComment(java.lang.String comment)

Set the server comment string.

Parameters:

comment - java.lang.String

setDomain

public final void setDomain(java.lang.String name)

Set the domain name that the host announcement are directed to.

Parameters:

name - java.lang.String

addHostName

public final void addHostName(java.lang.String name)

Add a host name to the list of names to announce

Parameters:

name - java.lang.String

addHostNames

public final void addHostNames(StringList names)

Add a list of names to the announcement list

Parameters:

names - StringList

setInterval

public final void setInterval(int intval)

Set the announcement interval, in minutes.

Parameters:

intval - int

setServerType

public final void setServerType(int typ)

Set the server type flags.

Parameters:

typ - int

shutdownAnnouncer

public final void shutdownAnnouncer()

Shutdown the host announcer and remove the announced name from Network Neighborhood.