ClientManagerFacadeImpl (I2P Anonymous Network - Java Documentation

java.lang.Object
- net.i2p.router.ClientManagerFacade
- - net.i2p.router.client.ClientManagerFacadeImpl

All Implemented Interfaces:: net.i2p.internal.InternalClientManager, Service

public class ClientManagerFacadeImpl
extends ClientManagerFacade
implements net.i2p.internal.InternalClientManager

Base impl of the client facade

Author:: jrandom

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_HOST`
`static int`	`DEFAULT_PORT`
`static String`	`PROP_CLIENT_HOST` note that this is different than the property the client side uses, i2cp.tcp.host
`static String`	`PROP_CLIENT_PORT` note that this is different than the property the client side uses, i2cp.tcp.port

Fields inherited from class net.i2p.router.ClientManagerFacade
PROP_CLIENT_ONLY

Constructor Summary

Constructors
Constructor and Description

ClientManagerFacadeImpl(RouterContext context)

Constructors
Constructor and Description
`ClientManagerFacadeImpl(RouterContext context)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`net.i2p.internal.I2CPMessageQueue`	`connect()` The InternalClientManager interface.
`net.i2p.data.i2cp.SessionConfig`	`getClientSessionConfig(net.i2p.data.Destination dest)` Return the client's current config, or null if not connected
`net.i2p.crypto.SessionKeyManager`	`getClientSessionKeyManager(net.i2p.data.Hash dest)` Return the client's current manager or null if not connected
`boolean`	`isAlive()`
`boolean`	`isLocal(net.i2p.data.Destination dest)` Determine if the destination specified is managed locally.
`boolean`	`isLocal(net.i2p.data.Hash destHash)` Determine if the destination specified is managed locally.
`Set<net.i2p.data.Destination>`	`listClients()` Return the list of locally connected clients
`void`	`messageDeliveryStatusUpdate(net.i2p.data.Destination fromDest, net.i2p.data.i2cp.MessageId id, long messageNonce, int status)`
`void`	`messageReceived(ClientMessage msg)`
`void`	`registerMetaDest(net.i2p.data.Destination dest)` Declare that we're going to publish a meta LS for this destination.
`void`	`renderStatusHTML(Writer out)` Deprecated. unused
`void`	`reportAbuse(net.i2p.data.Destination dest, String reason, int severity)` Instruct the client (or all clients) that they are under attack.
`void`	`requestLeaseSet(net.i2p.data.Destination dest, net.i2p.data.LeaseSet set, long timeout, Job onCreateJob, Job onFailedJob)` Request that a particular client authorize the Leases contained in the LeaseSet, after which the onCreateJob is queued up.
`void`	`requestLeaseSet(net.i2p.data.Hash dest, net.i2p.data.LeaseSet set)` Request that a particular client authorize the Leases contained in the LeaseSet.
`void`	`restart()` Perform a soft restart.
`boolean`	`shouldPublishLeaseSet(net.i2p.data.Hash destinationHash)` Does the client specified want their leaseSet published?
`void`	`shutdown()` Instruct the service that the router is shutting down and that it should do whatever is necessary to go down gracefully.
`void`	`shutdown(String msg)`
`void`	`startup()` Instruct the service that it should start normal operation.
`void`	`unregisterMetaDest(net.i2p.data.Destination dest)` Declare that we're no longer going to publish a meta LS for this destination.
`boolean`	`verifyClientLiveliness()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROP_CLIENT_PORT
```
public static final String PROP_CLIENT_PORT
```
    note that this is different than the property the client side uses, i2cp.tcp.port
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
    See Also:
    
    Constant Field Values
  - PROP_CLIENT_HOST
```
public static final String PROP_CLIENT_HOST
```
    note that this is different than the property the client side uses, i2cp.tcp.host
    
    See Also:
    
    Constant Field Values
  - DEFAULT_HOST
```
public static final String DEFAULT_HOST
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ClientManagerFacadeImpl
```
public ClientManagerFacadeImpl(RouterContext context)
```
- Method Detail
  - startup
```
public void startup()
```
    Description copied from interface: Service
    
    Instruct the service that it should start normal operation. This call DOES block until the service is ready.
    
    Specified by:
    
    startup in interface Service
  - shutdown
```
public void shutdown()
```
    Description copied from interface: Service
    
    Instruct the service that the router is shutting down and that it should do whatever is necessary to go down gracefully. It should not depend on other components at this point. This call DOES block.
    
    Specified by:
    
    shutdown in interface Service
  - shutdown
```
public void shutdown(String msg)
```
    Specified by:
    
    shutdown in class ClientManagerFacade
    
    Parameters:
    
    msg - message to send to the clients
    
    Since:
    
    0.8.8
  - restart
```
public void restart()
```
    Description copied from interface: Service
    
    Perform a soft restart.
    
    Specified by:
    
    restart in interface Service
  - isAlive
```
public boolean isAlive()
```
    Overrides:
    
    isAlive in class ClientManagerFacade
  - verifyClientLiveliness
```
public boolean verifyClientLiveliness()
```
    Overrides:
    
    verifyClientLiveliness in class ClientManagerFacade
  - requestLeaseSet
```
public void requestLeaseSet(net.i2p.data.Destination dest,
                            net.i2p.data.LeaseSet set,
                            long timeout,
                            Job onCreateJob,
                            Job onFailedJob)
```
    Request that a particular client authorize the Leases contained in the LeaseSet, after which the onCreateJob is queued up. If that doesn't occur within the timeout specified, queue up the onFailedJob. This call does not block. UNUSED, the call below without jobs is always used.
    
    Specified by:
    
    requestLeaseSet in class ClientManagerFacade
    
    Parameters:
    
    dest - Destination from which the LeaseSet's authorization should be requested
    
    set - LeaseSet with requested leases - this object must be updated to contain the signed version (as well as any changed/added/removed Leases) The LeaseSet contains Leases only; it is unsigned and does not have the destination set.
    
    timeout - ms to wait before failing
    
    onCreateJob - Job to run after the LeaseSet is authorized
    
    onFailedJob - Job to run after the timeout passes without receiving authorization
  - requestLeaseSet
```
public void requestLeaseSet(net.i2p.data.Hash dest,
                            net.i2p.data.LeaseSet set)
```
    Request that a particular client authorize the Leases contained in the LeaseSet.
    
    Specified by:
    
    requestLeaseSet in class ClientManagerFacade
    
    Parameters:
    
    dest - Destination from which the LeaseSet's authorization should be requested
    
    set - LeaseSet with requested leases - this object must be updated to contain the signed version (as well as any changed/added/removed Leases). The LeaseSet contains Leases only; it is unsigned and does not have the destination set.
  - reportAbuse
```
public void reportAbuse(net.i2p.data.Destination dest,
                        String reason,
                        int severity)
```
    Instruct the client (or all clients) that they are under attack. This call does not block.
    
    Specified by:
    
    reportAbuse in class ClientManagerFacade
    
    Parameters:
    
    dest - Destination under attack, or null if all destinations are affected
    
    reason - Why the router thinks that there is abusive behavior
    
    severity - How severe the abuse is, with 0 being not severe and 255 is the max
  - isLocal
```
public boolean isLocal(net.i2p.data.Destination dest)
```
    Determine if the destination specified is managed locally. This call DOES block.
    
    Specified by:
    
    isLocal in class ClientManagerFacade
    
    Parameters:
    
    dest - Destination to be checked
  - isLocal
```
public boolean isLocal(net.i2p.data.Hash destHash)
```
    Determine if the destination specified is managed locally. This call DOES block.
    
    Specified by:
    
    isLocal in class ClientManagerFacade
    
    Parameters:
    
    destHash - Hash of Destination to be checked
  - shouldPublishLeaseSet
```
public boolean shouldPublishLeaseSet(net.i2p.data.Hash destinationHash)
```
    Description copied from class: ClientManagerFacade
    
    Does the client specified want their leaseSet published?
    
    Overrides:
    
    shouldPublishLeaseSet in class ClientManagerFacade
  - messageDeliveryStatusUpdate
```
public void messageDeliveryStatusUpdate(net.i2p.data.Destination fromDest,
                                        net.i2p.data.i2cp.MessageId id,
                                        long messageNonce,
                                        int status)
```
    Specified by:
    
    messageDeliveryStatusUpdate in class ClientManagerFacade
    
    Parameters:
    
    id - the router's ID for this message
    
    messageNonce - the client's ID for this message, greater than zero
    
    status - see I2CP MessageStatusMessage for success/failure codes
  - messageReceived
```
public void messageReceived(ClientMessage msg)
```
    Specified by:
    
    messageReceived in class ClientManagerFacade
  - getClientSessionConfig
```
public net.i2p.data.i2cp.SessionConfig getClientSessionConfig(net.i2p.data.Destination dest)
```
    Return the client's current config, or null if not connected
    
    Specified by:
    
    getClientSessionConfig in class ClientManagerFacade
  - getClientSessionKeyManager
```
public net.i2p.crypto.SessionKeyManager getClientSessionKeyManager(net.i2p.data.Hash dest)
```
    Return the client's current manager or null if not connected
    
    Specified by:
    
    getClientSessionKeyManager in class ClientManagerFacade
  - renderStatusHTML
```
@Deprecated
public void renderStatusHTML(Writer out)
                                  throws IOException
```
    Deprecated. unused
    
    Specified by:
    
    renderStatusHTML in interface Service
    
    Overrides:
    
    renderStatusHTML in class ClientManagerFacade
    
    Throws:
    
    IOException
  - listClients
```
public Set<net.i2p.data.Destination> listClients()
```
    Return the list of locally connected clients
    
    Overrides:
    
    listClients in class ClientManagerFacade
    
    Returns:
    
    set of Destination objects
  - connect
```
public net.i2p.internal.I2CPMessageQueue connect()
                                          throws net.i2p.client.I2PSessionException
```
    The InternalClientManager interface. Connect to the router, receiving a message queue to talk to the router with.
    
    Specified by:
    
    connect in interface net.i2p.internal.InternalClientManager
    
    Throws:
    
    net.i2p.client.I2PSessionException - if the router isn't ready
    
    Since:
    
    0.8.3
  - registerMetaDest
```
public void registerMetaDest(net.i2p.data.Destination dest)
                      throws net.i2p.client.I2PSessionException
```
    Declare that we're going to publish a meta LS for this destination. Must be called before publishing the leaseset.
    
    Overrides:
    
    registerMetaDest in class ClientManagerFacade
    
    Throws:
    
    net.i2p.client.I2PSessionException - on duplicate dest
    
    Since:
    
    0.9.41
  - unregisterMetaDest
```
public void unregisterMetaDest(net.i2p.data.Destination dest)
```
    Declare that we're no longer going to publish a meta LS for this destination.
    
    Overrides:
    
    unregisterMetaDest in class ClientManagerFacade
    
    Since:
    
    0.9.41

Class ClientManagerFacadeImpl

Field Summary

Fields inherited from class net.i2p.router.ClientManagerFacade

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_CLIENT_PORT

DEFAULT_PORT

PROP_CLIENT_HOST

DEFAULT_HOST

Constructor Detail

ClientManagerFacadeImpl

Method Detail

startup

shutdown

shutdown

restart

isAlive

verifyClientLiveliness

requestLeaseSet

requestLeaseSet

reportAbuse

isLocal

isLocal

shouldPublishLeaseSet

messageDeliveryStatusUpdate

messageReceived

getClientSessionConfig

getClientSessionKeyManager

renderStatusHTML

listClients

connect

registerMetaDest

unregisterMetaDest