org.apache.lens.client

Class LensConnection

java.lang.Object

org.apache.lens.client.LensConnection

All Implemented Interfaces:

AutoCloseable

public class LensConnection
extends Object
implements AutoCloseable

Top level client connection class which is used to connect to a lens server.

Constructor Summary

Constructors

Constructor and Description
LensConnection(LensConnectionParams params) Construct a connection to lens server specified by connection parameters.
LensConnection(LensConnectionParams params, LensSessionHandle sessionHandle) Construct a connection to lens server specified by connection parameters with an already established session

Method Summary

Modifier and Type	Method and Description
APIResult	addResourceToConnection(String type, String resourcePath) Adds the resource to connection.
APIResult	attachDatabaseToSession() Attach database to session.
javax.ws.rs.client.Client	buildClient()
void	close() Close the connection.
List<String>	getConnectionParams()
List<String>	getConnectionParams(String key) Gets the connection params.
Map<String,String>	getConnectionParamsAsMap()
LensConnectionParams	getLensConnectionParams()
javax.ws.rs.core.Response	getLogs(String logFile) get the logs for a given log file
javax.ws.rs.client.WebTarget	getLogWebTarget()
javax.ws.rs.client.WebTarget	getLogWebTarget(javax.ws.rs.client.Client client)
LensSessionHandle	getSessionHandle() The session handle.
boolean	isOpen() Check if the connection is opened.
List<String>	listResourcesFromConnection(String type) List resources from session
LensSessionHandle	open(String password) Open.
APIResult	removeResourceFromConnection(String type, String resourcePath) Removes the resource from connection.
APIResult	setConnectionParams(String key, String value) Sets the connection params.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LensConnection

public LensConnection(LensConnectionParams params)

Construct a connection to lens server specified by connection parameters.

Parameters:

params - parameters to be used for creating a connection

LensConnection

public LensConnection(LensConnectionParams params,
                      LensSessionHandle sessionHandle)

Construct a connection to lens server specified by connection parameters with an already established session

Parameters:

params - parameters to be used for creating a connection

Method Detail

isOpen

public boolean isOpen()

Check if the connection is opened. Please note that,lens connections are persistent connections. But a session mapped by ID running on the lens server.

Returns:

true if connected to server

buildClient

public javax.ws.rs.client.Client buildClient()

getLogWebTarget

public javax.ws.rs.client.WebTarget getLogWebTarget()

getLogWebTarget

public javax.ws.rs.client.WebTarget getLogWebTarget(javax.ws.rs.client.Client client)

open

public LensSessionHandle open(String password)

Open.

Parameters:

password - the password

Returns:

the lens session handle

attachDatabaseToSession

public APIResult attachDatabaseToSession()

Attach database to session.

Returns:

the API result

close

public void close()

Close the connection.

Specified by:

close in interface AutoCloseable

addResourceToConnection

public APIResult addResourceToConnection(String type,
                                         String resourcePath)

Adds the resource to connection.

Parameters:

type - the type

resourcePath - the resource path

Returns:

the API result

removeResourceFromConnection

public APIResult removeResourceFromConnection(String type,
                                              String resourcePath)

Removes the resource from connection.

Parameters:

type - the type

resourcePath - the resource path

Returns:

the API result

listResourcesFromConnection

public List<String> listResourcesFromConnection(String type)

List resources from session

Parameters:

type - type of resource

Returns:

List of resources

getLogs

public javax.ws.rs.core.Response getLogs(String logFile)

get the logs for a given log file

Parameters:

logFile - log segregation

setConnectionParams

public APIResult setConnectionParams(String key,
                                     String value)

Sets the connection params.

Parameters:

key - the key

value - the value

Returns:

the API result

getConnectionParams

public List<String> getConnectionParams()

getConnectionParams

public List<String> getConnectionParams(String key)

Gets the connection params.

Parameters:

key - the key

Returns:

the connection params

getConnectionParamsAsMap

public Map<String,String> getConnectionParamsAsMap()

getLensConnectionParams

public LensConnectionParams getLensConnectionParams()

toString

public String toString()

Overrides:

toString in class Object

getSessionHandle

@Generated(value="lombok")
public LensSessionHandle getSessionHandle()

The session handle.