Bees v0.5.0 API

apps.authenticator
Class Authenticator

java.lang.Object
  |
  +--bees.core.Application
        |
        +--apps.authenticator.Authenticator
Direct Known Subclasses:
Everything, SourceBased

public abstract class Authenticator
extends Application

The Authenticator class provides a base for applications that wish to authenticate protocol flows. In addition, it will use the discovery and liveness protocols to track neighbors on the local network.


Constructor Summary
protected Authenticator()
          Construct an empty Authenticator object.
 
Method Summary
protected  AuthenticatorParameters createAuthenticatorParameters(Node node)
           
protected  DLProtocolPresentation createDLProtocolPresentation(TypeID fi)
           
protected  IDTranslatorPresentation createIDTranslatorPresentation()
           
protected abstract  UnknownProtocolPresentation createUnknownProtocolPresentation()
           
 AuthenticatorParameters getAuthenticatorParameters()
           
 CapabilityTree getCommonCapabilities()
           
 DiscoveryProtocolPresentation getDiscoveryPresentation()
           
 IDTranslatorPresentation getIDTranslatorPresentation()
           
 Capability[] getInitialCapabilities()
           
 LivenessPresentation getLivenessPresentation()
           
 LoggerFactory getLoggerFactory()
           
 apps.authenticator.NeighborManager getNeighborManager()
           
 Node getNode()
           
 NodeCache getNodeCache()
           
 UnknownProtocolPresentation getUnknownProtocolPresentation()
           
 void start(Node node, java.lang.String[] args)
          Method called to set the application in motion.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Authenticator

protected Authenticator()
Construct an empty Authenticator object.
Method Detail

getLoggerFactory

public LoggerFactory getLoggerFactory()
Returns:
Factory used to make Loggers for downloaded protocols.

getNode

public Node getNode()
Returns:
Cached pointer to the current Node.

getNodeCache

public NodeCache getNodeCache()
Returns:
The Authenticator's private NodeCache.

getAuthenticatorParameters

public AuthenticatorParameters getAuthenticatorParameters()
Returns:
The parameters for this Authenticator.

getNeighborManager

public apps.authenticator.NeighborManager getNeighborManager()
Returns:
The object used to track Neighbors and notify protocols when they are found or lost.

getCommonCapabilities

public CapabilityTree getCommonCapabilities()
Returns:
A common set of capabilities for authenticated protocols.

getInitialCapabilities

public Capability[] getInitialCapabilities()
Returns:
The set of initial capabilities for new BDomains.

getUnknownProtocolPresentation

public UnknownProtocolPresentation getUnknownProtocolPresentation()
Returns:
The ProtocolPresentation used to communicate with the UnknownProtocol.

getIDTranslatorPresentation

public IDTranslatorPresentation getIDTranslatorPresentation()
Returns:
The ProtocolPresentation used to communicate with the IDTranslatorProtocol.

getDiscoveryPresentation

public DiscoveryProtocolPresentation getDiscoveryPresentation()
Returns:
The ProtocolPresentation used to communicate with the DiscoveryProtocol.

getLivenessPresentation

public LivenessPresentation getLivenessPresentation()
Returns:
The ProtocolPresentation used to communicate with the LivenessProtocol.

createUnknownProtocolPresentation

protected abstract UnknownProtocolPresentation createUnknownProtocolPresentation()
Returns:
An UnknownProtocolPresentation subclass that handles freshly downloaded protocol flow descriptions.

createIDTranslatorPresentation

protected IDTranslatorPresentation createIDTranslatorPresentation()
Returns:
An IDTranslatorPresentation subclass that handles mapped flow identifiers.

createDLProtocolPresentation

protected DLProtocolPresentation createDLProtocolPresentation(TypeID fi)
Parameters:
fi - The flow identifier being downloaded.
Returns:
A DLProtocolPresentation subclass that handles bootstrapping of new protocols.

createAuthenticatorParameters

protected AuthenticatorParameters createAuthenticatorParameters(Node node)
Parameters:
node - The current Node object.
Returns:
An AuthenticatorParameters that holds the interesting parameters for this Authenticator.

start

public void start(Node node,
                  java.lang.String[] args)
           throws java.lang.Throwable
Description copied from class: Application
Method called to set the application in motion.
Overrides:
start in class Application
See Also:
Application.start(Node, String[])

toString

public java.lang.String toString()
Overrides:
toString in class Application
See Also:
Object.toString()

Bees v0.5.0 API

This documentation is Copyright (C) 2002 The University of Utah. All Rights Reserved. See the individual source files for distribution terms.
Documentation, software, and mailing lists for Bees v0.5.0 can be found at the Janos Project: http://www.cs.utah.edu/flux/janos/