Session (safe-app-android API)

java.lang.Object
- net.maidsafe.api.Session

Direct Known Subclasses:

Client
```
public class Session
extends java.lang.Object
```
Holds a client session with the network. This is the primary interface to interact with the network. As such it provides all API-Providers connected through this session.

Field Summary

Fields
Modifier and Type	Field and Description
`CipherOpt`	`cipherOpt`
`Crypto`	`crypto`
`IData`	`iData`
`MData`	`mData`
`MDataEntries`	`mDataEntries`
`MDataEntryAction`	`mDataEntryAction`
`MDataPermission`	`mDataPermission`
`NFS`	`nfs`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Session(net.maidsafe.api.AppHandle appHandle, net.maidsafe.api.DisconnectListener disconnectListener)

Constructors
Modifier	Constructor and Description
`protected`	`Session(net.maidsafe.api.AppHandle appHandle, net.maidsafe.api.DisconnectListener disconnectListener)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.util.concurrent.CompletableFuture<Session>`	`connect(byte[] bootStrapConfig)` Establish a new unregistered session using the bootstrap config from the response
`static java.util.concurrent.CompletableFuture<Session>`	`connect(java.lang.String appId, AuthGranted authGranted)` Establish a new registered session with the network for the app
`static java.util.concurrent.CompletableFuture<Session>`	`connect(UnregisteredClientResponse response)` Establish a new unregistered session
`static java.util.concurrent.CompletableFuture<Session>`	`createTestApp(java.lang.String appId)` Creates a random app instance for testing
`static java.util.concurrent.CompletableFuture<Session>`	`createTestAppWithAccess(AuthReq authReq)` Creates a random app instance for testing
`static java.util.concurrent.CompletableFuture<DecodeResult>`	`decodeIpcMessage(java.lang.String response)` Decodes the encoded response from the Authenticator
`static java.util.concurrent.CompletableFuture<Request>`	`encodeAuthReq(AuthReq req)` Encodes an Auth request for authentication
`java.util.concurrent.CompletableFuture<AccountInfo>`	`getAccountInfo()` Get the account usage statistics (mutations done and mutations available)
`static java.util.concurrent.CompletableFuture<java.lang.String>`	`getAppContainerName(java.lang.String appId)` Get the App's container name
`static java.util.concurrent.CompletableFuture<java.lang.String>`	`getAppStem()` Returns the expected name for the app's executable without the extension
`java.util.concurrent.CompletableFuture<MDataInfo>`	`getContainerMDataInfo(java.lang.String containerName)` Get the mDataInfo for the App container
`java.util.concurrent.CompletableFuture<java.util.List<ContainerPermissions>>`	`getContainerPermissions()` Retrieve a list of container names that an app has access to.
`static java.util.concurrent.CompletableFuture<Request>`	`getContainersReq(ContainersReq containersReq)` Encode a Containers request that is to be sent to the Authenticator
`static java.util.concurrent.CompletableFuture<java.lang.String>`	`getLogOutputPath(java.lang.String logFileName)` Get the full path for the log file
`static java.util.concurrent.CompletableFuture<Request>`	`getShareMutableDataRequest(ShareMDataReq req)` Encodes a share Mutable Data request
`static java.util.concurrent.CompletableFuture<Request>`	`getUnregisteredSessionRequest(java.lang.String appId)` Encodes a request for an unregistered session
`static java.util.concurrent.CompletableFuture`	`initLogging(java.lang.String outputFileName)` Initialises logging to a file.
`boolean`	`isConnected()` Returns true if the client is connected to the network
`static boolean`	`isMock()` Returns true if libraries were compiled for mock routing
`java.util.concurrent.CompletableFuture`	`reconnect()` Attempt to restore a failed connection with the network.
`java.util.concurrent.CompletableFuture`	`refreshAccessInfo()` Fetch latest access information from the network
`java.util.concurrent.CompletableFuture`	`resetObjectCache()` Resets the object cache.
`static java.util.concurrent.CompletableFuture`	`setAdditionalSearchPath(java.lang.String path)` Sets additional search paths in `config_file_handler` to search for files
`void`	`setOnDisconnectListener(OnDisconnected disconnectedAction)` Sets the disconnected listener to perform an action when the client is disconnected
`java.util.concurrent.CompletableFuture`	`testSimulateDisconnect()` Simulates the disconnect event

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

- Field Detail
  - cipherOpt
```
public final CipherOpt cipherOpt
```
  - crypto
```
public final Crypto crypto
```
  - iData
```
public final IData iData
```
  - mData
```
public final MData mData
```
  - mDataEntries
```
public final MDataEntries mDataEntries
```
  - mDataEntryAction
```
public final MDataEntryAction mDataEntryAction
```
  - mDataPermission
```
public final MDataPermission mDataPermission
```
  - nfs
```
public final NFS nfs
```
- Constructor Detail
  - Session
```
protected Session(net.maidsafe.api.AppHandle appHandle,
                  net.maidsafe.api.DisconnectListener disconnectListener)
```
- Method Detail
  - initLogging
```
public static java.util.concurrent.CompletableFuture initLogging(java.lang.String outputFileName)
```
    Initialises logging to a file.
    
    Parameters:
    
    outputFileName - File name
  - getLogOutputPath
```
public static java.util.concurrent.CompletableFuture<java.lang.String> getLogOutputPath(java.lang.String logFileName)
```
    Get the full path for the log file
    
    Parameters:
    
    logFileName - Log file name
    
    Returns:
    
    Path to the log file
  - getAppContainerName
```
public static java.util.concurrent.CompletableFuture<java.lang.String> getAppContainerName(java.lang.String appId)
```
    Get the App's container name
    
    Parameters:
    
    appId - Application ID
    
    Returns:
    
    App container name
  - setAdditionalSearchPath
```
public static java.util.concurrent.CompletableFuture setAdditionalSearchPath(java.lang.String path)
```
    Sets additional search paths in `config_file_handler` to search for files
    
    Parameters:
    
    path - New path to be added
  - getAppStem
```
public static java.util.concurrent.CompletableFuture<java.lang.String> getAppStem()
```
    Returns the expected name for the app's executable without the extension
    
    Returns:
    
    App executable name
  - encodeAuthReq
```
public static java.util.concurrent.CompletableFuture<Request> encodeAuthReq(AuthReq req)
```
    Encodes an Auth request for authentication
    
    Parameters:
    
    req - The AuthReq to be encoded
    
    Returns:
    
    Encoded auth request as Request
  - getShareMutableDataRequest
```
public static java.util.concurrent.CompletableFuture<Request> getShareMutableDataRequest(ShareMDataReq req)
```
    Encodes a share Mutable Data request
    
    Parameters:
    
    req - Share Mutable Data request
    
    Returns:
    
    Encoded share Mutable Data request as Request
  - getUnregisteredSessionRequest
```
public static java.util.concurrent.CompletableFuture<Request> getUnregisteredSessionRequest(java.lang.String appId)
```
    Encodes a request for an unregistered session
    
    Parameters:
    
    appId - Application ID
    
    Returns:
    
    Encoded unregistered session Request as Request
  - decodeIpcMessage
```
public static java.util.concurrent.CompletableFuture<DecodeResult> decodeIpcMessage(java.lang.String response)
```
    Decodes the encoded response from the Authenticator
    
    Parameters:
    
    response - The encoded response from the Authenticator
    
    Returns:
    
    Decoded response as DecodeResult
  - connect
```
public static java.util.concurrent.CompletableFuture<Session> connect(UnregisteredClientResponse response)
```
    Establish a new unregistered session
    
    Parameters:
    
    response - Unregistered response from the Authenticator
    
    Returns:
    
    New Session instance
  - getContainersReq
```
public static java.util.concurrent.CompletableFuture<Request> getContainersReq(ContainersReq containersReq)
```
    Encode a Containers request that is to be sent to the Authenticator
    
    Parameters:
    
    containersReq - Containers request
    
    Returns:
    
    Encoded containers request
  - connect
```
public static java.util.concurrent.CompletableFuture<Session> connect(byte[] bootStrapConfig)
```
    Establish a new unregistered session using the bootstrap config from the response
    
    Parameters:
    
    bootStrapConfig - Bootstrap configuration
    
    Returns:
    
    A new Session instance
  - connect
```
public static java.util.concurrent.CompletableFuture<Session> connect(java.lang.String appId,
                                                                      AuthGranted authGranted)
```
    Establish a new registered session with the network for the app
    
    Parameters:
    
    appId - Application ID
    
    authGranted - Authentication reponse.
    
    Returns:
    
    A new Session object
  - isMock
```
public static boolean isMock()
```
    Returns true if libraries were compiled for mock routing
  - isConnected
```
public boolean isConnected()
```
    Returns true if the client is connected to the network
    
    Returns:
    
    Connected status as boolean
  - setOnDisconnectListener
```
public void setOnDisconnectListener(OnDisconnected disconnectedAction)
```
    Sets the disconnected listener to perform an action when the client is disconnected
    
    Parameters:
    
    disconnectedAction - Action to be performed on disconnection
  - getAccountInfo
```
public java.util.concurrent.CompletableFuture<AccountInfo> getAccountInfo()
```
    Get the account usage statistics (mutations done and mutations available)
    
    Returns:
    
    Account information as AccountInfo
  - resetObjectCache
```
public java.util.concurrent.CompletableFuture resetObjectCache()
```
    Resets the object cache. Removes all objects currently in the object cache and invalidates all existing object handles.
  - refreshAccessInfo
```
public java.util.concurrent.CompletableFuture refreshAccessInfo()
```
    Fetch latest access information from the network
  - getContainerMDataInfo
```
public java.util.concurrent.CompletableFuture<MDataInfo> getContainerMDataInfo(java.lang.String containerName)
```
    Get the mDataInfo for the App container
    
    Parameters:
    
    containerName - App container name
    
    Returns:
    
    mDataInfo for the App container Mutable Data
  - getContainerPermissions
```
public java.util.concurrent.CompletableFuture<java.util.List<ContainerPermissions>> getContainerPermissions()
```
    Retrieve a list of container names that an app has access to.
    
    Returns:
    
    List of container permissions given to an application as List<ContainerPermissions>
  - reconnect
```
public java.util.concurrent.CompletableFuture reconnect()
```
    Attempt to restore a failed connection with the network.
  - testSimulateDisconnect
```
public java.util.concurrent.CompletableFuture testSimulateDisconnect()
```
    Simulates the disconnect event
  - createTestApp
```
public static java.util.concurrent.CompletableFuture<Session> createTestApp(java.lang.String appId)
```
    Creates a random app instance for testing
    
    Parameters:
    
    appId - Application ID
    
    Returns:
    
    New Session instance
  - createTestAppWithAccess
```
public static java.util.concurrent.CompletableFuture<Session> createTestAppWithAccess(AuthReq authReq)
```
    Creates a random app instance for testing
    
    Parameters:
    
    authReq - Auth request
    
    Returns:
    
    New Session instance

Class Session

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cipherOpt

crypto

iData

mData

mDataEntries

mDataEntryAction

mDataPermission

nfs

Constructor Detail

Session

Method Detail

initLogging

getLogOutputPath

getAppContainerName

setAdditionalSearchPath

getAppStem

encodeAuthReq

getShareMutableDataRequest

getUnregisteredSessionRequest

decodeIpcMessage

connect

getContainersReq

connect

connect

isMock

isConnected

setOnDisconnectListener

getAccountInfo

resetObjectCache

refreshAccessInfo

getContainerMDataInfo

getContainerPermissions

reconnect

testSimulateDisconnect

createTestApp

createTestAppWithAccess