API Docs for:
Show:

BaseEnvironment Class

Defined in: app/store/env/base.js:12
Module: env.base
Parent Module: env

The Base Juju environment.

This class is intended to be subclassed by real environment implementations.

Methods

_firePermissionDenied

(
  • op
)
Undefined private

Defined in app/store/env/base.js:189

Fire a "permissionDenied" event passing the attempted operation.

Parameters:

  • op Object

    The attempted operation (with an "op" attr).

Returns:

Undefined: Fires an event only.

dispatch_result

(
  • data
)
Undefined

Defined in app/store/env/base.js:174

Dispatch the results returned by the API backend. Take care of calling attached callbacks and firing events. Subclasses must implement the "dispatchrpcresult" and "dispatch_event" methods or override this method directly.

Parameters:

  • data Object

    The JSON contents returned by the API backend.

Returns:

Undefined: Dispatches only.

get

() Boolean

Defined in app/store/env/base.js:229

Returns whether or not credentials are populated.

Returns:

Boolean: Whether or not user and password are set.

getCredentials

() Object

Defined in app/store/env/base.js:217

Retrieve the stored user credentials.

Returns:

Object: The stored user credentials with a 'user' and a 'password' attribute.

logout

() Undefined

Defined in app/store/env/base.js:245

Clear login information.

Returns:

Undefined: Nothing.

on_message

(
  • evt
)
Undefined

Defined in app/store/env/base.js:163

Fire a "msg" event when a message is received from the WebSocket.

Parameters:

  • evt Object

    The event triggered by the WebSocket.

Returns:

Undefined: Fire an event only.

setCredentials

(
  • The
)
Undefined

Defined in app/store/env/base.js:205

Store the user's credentials in session storage.

Parameters:

  • The Object

    credentials to store, with a 'user' and a 'password' attribute included.

Returns:

Undefined: Stores data only.

Attributes

conn

Object

Defined in app/store/env/base.js:34

The connection object.

connected

Boolean

Defined in app/store/env/base.js:55

Whether or not the connection is open.

debug

Boolean

Defined in app/store/env/base.js:62

Whether or not to run in debug mode.

defaultSeries

String

Defined in app/store/env/base.js:76

The default series (e.g.: precise) as provided by juju.

environmentName

String

Defined in app/store/env/base.js:90

The environment name as provided by juju.

password

String

Defined in app/store/env/base.js:48

The password used to connect.

providerType

String

Defined in app/store/env/base.js:83

The provider type (e.g.: ec2) as provided by juju.

readOnly

Boolean

Defined in app/store/env/base.js:69

Whether or not to run in read-only mode

socket_url

String

Defined in app/store/env/base.js:27

The websocket URL to connect to.

user

String

Defined in app/store/env/base.js:41

The username used to connect.