com.exalead.papi.helper

Class PushAPISession

java.lang.Object

com.exalead.papi.helper.PushAPISession

public class PushAPISession
extends java.lang.Object

Push API session helper.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	opened
protected PushAPI	papi

Constructor Summary

Constructors

Constructor and Description
PushAPISession(PushAPI papi) Build a new PushAPISession and start the session, if none was already opened.
PushAPISession(PushAPI papi, boolean start) Build a new PushAPISession.

Method Summary

Modifier and Type	Method and Description
void	close() Close a pushAPI session, if opened.
void	open() Attempt to start a new pushAPI session if no session was yet opened.

Methods inherited from class java.lang.Object

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

Field Detail

papi

protected final PushAPI papi

opened

protected boolean opened

Constructor Detail

PushAPISession

public PushAPISession(PushAPI papi)
               throws PushAPIException

Build a new PushAPISession and start the session, if none was already opened. The close() method MUST be called to ensure proper session closing.

Throws:

PushAPIException

PushAPISession

public PushAPISession(PushAPI papi,
                      boolean start)
               throws PushAPIException

Build a new PushAPISession.

Parameters:

start - if true, start the session

Throws:

PushAPIException

Method Detail

open

public void open()
          throws PushAPIException

Attempt to start a new pushAPI session if no session was yet opened.

Throws:

PushAPIException

close

public void close()
           throws PushAPIException

Close a pushAPI session, if opened. Note: calling this function when a session is not opened is NOOP.

Throws:

PushAPIException