build
String  build

Returns the current version (major, minor, build)

Returns
String  build String

Supported Clients
SmartClient, WebClient, NGClient

buildDate
Date  buildDate

Returns date release date

Returns
Date  date Date

Supported Clients
SmartClient, WebClient, NGClient

component
String  component

Returns the component name

Returns
String  name String

Supported Clients
SmartClient, WebClient, NGClient

licensee
String  licensee

Returns the licensee

Returns
String  licensee String

Supported Clients
SmartClient, WebClient, NGClient

typeLicensed
String  typeLicensed

Returns the type that is valid for this license

Returns
String  type String

Supported Clients
SmartClient, WebClient, NGClient

version
Number  version

Returns the current version (major, minor)

Returns
Number  version Double

Supported Clients
SmartClient, WebClient, NGClient

versionLicensed
String  versionLicensed

Returns the version that is valid for this license

Returns
String  license String

Supported Clients
SmartClient, WebClient, NGClient

createClient
CloudStorageClient  createClient( String, String, String, String, String, Number, String )

Creates a client with the given provider, host, username, password, default remote path, port number, and region.

Parameters
String  providerName  Name of the provider (ex. plugins.it2be_cloudstorage.PROVIDERS.LOCAL)
String  host  Hostname to connect to. For providers that don't have hosts, pass null.
String  username  Connection username
String  password  Connection password
String  defaultPath  Default remote path on the server
Number  portNumber  Server port number
String  region  Region name

Returns
CloudStorageClient  CloudStorageClient

Supported Clients
SmartClient, WebClient, NGClient

Sample

var client = plugins.it2be_cloudstorage.createClient(plugins.it2be_cloudstorage.PROVIDERS.S3, null, "aws_access_key_id", "aws_secret_access_key", "/my-bucket", null, "us-west-1")

createClient
CloudStorageClient  createClient( String, String, String, String, String )

Creates a client with the given provider, host, username, password, and default remote path

Parameters
String  providerName  Name of the provider (ex. plugins.it2be_cloudstorage.PROVIDERS.LOCAL)
String  host  Hostname to connect to. For providers that don't have hosts, pass null.
String  username  Connection username
String  password  Connection password
String  defaultPath  Default remote path on the server

Returns
CloudStorageClient  CloudStorageClient

Supported Clients
SmartClient, WebClient, NGClient

Sample

var client = plugins.it2be_cloudstorage.createClient(plugins.it2be_cloudstorage.PROVIDERS.SFTP, "my.server.com", "username", "password", "/home/username")

createClient
CloudStorageClient  createClient( String, String, String, String, String, Number )

Creates a client with the given provider, host, username, password, default remote path, and port number.

Parameters
String  providerName  Name of the provider (ex. plugins.it2be_cloudstorage.PROVIDERS.LOCAL)
String  host  Hostname to connect to. For providers that don't have hosts, pass null.
String  username  Connection username
String  password  Connection password
String  defaultPath  Default remote path on the server
Number  portNumber  Server port number

Returns
CloudStorageClient  CloudStorageClient

Supported Clients
SmartClient, WebClient, NGClient

Sample

var client = plugins.it2be_cloudstorage.createClient(plugins.it2be_cloudstorage.PROVIDERS.SFTP, "my.server.com", "username", "password", "/home/username", 2222)

createClient
CloudStorageClient  createClient( String, String, String, String )

Creates a client with the given provider, host, username, and password

Parameters
String  providerName  Name of the provider (ex. plugins.it2be_cloudstorage.PROVIDERS.LOCAL)
String  host  Hostname to connect to. For providers that don't have hosts, pass null.
String  username  Connection username
String  password  Connection password

Returns
CloudStorageClient  CloudStorageClient

Supported Clients
SmartClient, WebClient, NGClient

Sample

var client = plugins.it2be_cloudstorage.createClient(plugins.it2be_cloudstorage.PROVIDERS.SFTP, "my.server.com", "username", "password")

createClient
CloudStorageClient  createClient( String, String )

Creates a client with the given provider and host

Parameters
String  providerName  Name of the provider (ex. plugins.it2be_cloudstorage.PROVIDERS.LOCAL)
String  host  Hostname to connect to. For providers that don't have hosts, pass null.

Returns
CloudStorageClient  CloudStorageClient

Supported Clients
SmartClient, WebClient, NGClient

Sample

var client = plugins.it2be_cloudstorage.createClient(plugins.it2be_cloudstorage.PROVIDERS.LOCAL, null)

register
Boolean  register( String )

Register your runtime license (use the Components Manager to request your license string)

Parameters
String  license  the license

Returns
Boolean  result boolean

Supported Clients
SmartClient, WebClient, NGClient

Sample

// You have to register your plug-in(s) and beans before you start using them
// One way to do so is create an 'onOpenSolution' method and add the 'register(.)' method(s) there
plugins.it2be_cloudstorage.register("Insert the license string(s) from your '*_runtime_license.txt' file here!");