Classes
- AbstractApplicationObject
- AbstractClusterObject
- AbstractDirectoryObject
- AbstractDomainObject
- AbstractMap
- AbstractNode
- AbstractObject
- AbstractPersistable
- AbstractPlatformDataStore
- AbstractPlatformObject
- AbstractPlatformObjectMap
- AbstractRegistrarObject
- AbstractReportableWarehouseObject
- AbstractRepositoryObject
- AbstractSelfableACLObject
- AbstractSelfableObject
- AbstractVaultObject
- AbstractWarehouseObject
- AbstractWarehouseObjectMap
- AbstractWebHostObject
- Activity
- ActivityMap
- AppHelper
- Application
- ApplicationMap
- Archive
- ArchiveMap
- Association
- AuditRecord
- AuditRecordMap
- AuthenticationGrant
- AuthenticationGrantMap
- AuthInfo
- AutoClientMapping
- AutoClientMappingMap
- BillingProviderConfiguration
- BillingProviderConfigurationMap
- BinaryAttachment
- Branch
- BranchMap
- Chainable
- Changeset
- ChangesetMap
- Client
- ClientMap
- Cluster
- Connection
- ConnectionMap
- ContainedDataStore
- Context
- ConversionTrigger
- ConversionTriggerMap
- CopyJob
- DataStore
- Definition
- DeployedApplication
- DeployedApplicationMap
- Descriptor
- DescriptorMap
- Directory
- DirectoryMap
- Domain
- DomainMap
- DomainPrincipal
- EmailMap
- EmailProvider
- EmailProviderMap
- Form
- HasFormAssociation
- HasTranslationAssociation
- Http
- Identity
- IdentityMap
- Interaction
- InteractionApplication
- InteractionApplicationMap
- InteractionCity
- InteractionCityMap
- InteractionContinent
- InteractionContinentMap
- InteractionCountry
- InteractionCountryMap
- InteractionDevice
- InteractionDeviceMap
- InteractionMap
- InteractionNode
- InteractionNodeMap
- InteractionOperatingSystem
- InteractionOperatingSystemMap
- InteractionPage
- InteractionPageMap
- InteractionPostalCode
- InteractionPostalCodeMap
- InteractionRegion
- InteractionRegionMap
- InteractionReport
- InteractionReportEntry
- InteractionReportEntryMap
- InteractionReportMap
- InteractionSession
- InteractionSessionMap
- InteractionUser
- InteractionUserAgent
- InteractionUserAgentMap
- InteractionUserMap
- Job
- JobMap
- LogEntry
- LogEntryMap
- Meter
- MeterMap
- Node
- NodeAttachment
- NodeAttachmentMap
- NodeMap
- OAuth2Http
- PageRendition
- PageRenditionMap
- Person
- Plan
- PlanMap
- Platform
- PlatformDataStoreMap
- PrincipalMap
- Project
- ProjectMap
- Registrar
- RegistrarMap
- Registration
- RegistrationMap
- Release
- ReleaseMap
- Report
- ReportMap
- Repository
- RepositoryMap
- Response
- Role
- RoleMap
- ScheduledWork
- ScheduledWorkMap
- Settings
- SettingsMap
- Stack
- StackMap
- SystemMetadata
- Team
- TeamMap
- TeamMember
- TeamMemberMap
- Tenant
- TenantMap
- Timestamp
- TransferExportJob
- TransferImportJob
- TraversalResults
- TrustedDomainMapping
- TrustedDomainMappingMap
- Vault
- VaultMap
- Warehouse
- WarehouseMap
- WebHost
- WebHostMap
- WorkflowComment
- WorkflowCommentMap
- WorkflowInstance
- WorkflowInstanceMap
- WorkflowModel
- WorkflowModelMap
- WorkflowTask
- WorkflowTaskMap
Methods
-
<static> copyInto(target, source)
-
Copies the members of the source object into the target object. This includes both properties and functions from the source object.
Parameters:
Name Type Description targetObject Target object.
sourceObject Source object.
-
<static> copyKeepers(target, source)
-
Copies only those members that are already represented on the target.
Parameters:
Name Type Description targetObject Target object.
sourceObject Source object.
-
<static> deleteCookie(name, path)
-
Deletes a cookie.
Parameters:
Name Type Description namepath -
<static> deleteProperties(object)
-
Deletes any owned properties of the given object. If specified, owned functions will also be deleted.
Parameters:
Name Type Description objectObject object
-
<static> isBoolean(arg) → {Boolean}
-
Determines whether the given argument is a Boolean.
Parameters:
Name Type Description argargument
Returns:
whether it is a Boolean
- Type
- Boolean
-
<static> isFunction(arg) → {Boolean}
-
Determines whether the given argument is a Function.
Parameters:
Name Type Description argargument
Returns:
whether it is a Function
- Type
- Boolean
-
<static> isNumber(arg) → {Boolean}
-
Determines whether the given argument is a Number.
Parameters:
Name Type Description argargument
Returns:
whether it is a Number
- Type
- Boolean
-
<static> isString(arg) → {Boolean}
-
Determines whether the given argument is a String.
Parameters:
Name Type Description argargument
Returns:
whether it is a String
- Type
- Boolean
-
<static> makeArray(arguments) → {Array}
-
Builds an array from javascript method arguments.
Parameters:
Name Type Description argumentsarguments Returns:
an array
- Type
- Array
-
<static> MemoryXHRCache() → {function}
-
Simple memory XHR Cache
- Source:
Returns:
- Type
- function
-
<static> stampInto(target, source)
-
Stamps the functions and properties from the source object to the target object.
Parameters:
Name Type Description targetObject Target object.
sourceObject Source object.
-
<static> startsWith(text, prefix) → {Boolean}
-
Determines whether a bit of text starts with a given prefix.
Parameters:
Name Type Description textString A bit of text.
prefixString The prefix.
Returns:
whether the text starts with the prefix.
- Type
- Boolean
-
<static> stringify(object, pretty) → {String}
-
Serializes a object into a JSON string and optionally makes it pretty by indenting.
Parameters:
Name Type Description objectObject The javascript object.
prettyBoolean Whether the resulting string should have indentation.
Returns:
string
- Type
- String
-
<static> writeCookie(name, value, String, Number, String)
-
Writes a cookie.
Parameters:
Name Type Argument Description nameString valueString String<optional>
path optional path (assumed "/" if not provided)
Number<optional>
days optional # of days to store cookie if null or -1, assume session cookie if 0, assume expired cookie if > 0, assume # of days
String<optional>
domain optional domain (otherwise assumes wildcard base domain)
-
ajax(method, url, contentType, data, headers, successCallback, failureCallback)
-
Performs Ajax communication with the Gitana server.
NOTE: For the most part, you shouldn't have to use this function since most of the things you'd want to do with the Gitana server are wrapped by helper functions.
Parameters:
Name Type Argument Description methodString The kind of method to invoke - "get", "post", "put", or "del"
urlString The full URL to the resource being requested (i.e. "http://server:port/uri"}
contentTypeString <optional>
In the case of a payload carrying request (i.e. not GET), the content type being sent.
dataObject <optional>
In the case of a payload carrying request (i.e. not GET), the data to plug into the payload.
headersObject <optional>
A key/value map of headers to place into the request.
successCallbackfunction <optional>
The function to call if the operation succeeds.
failureCallbackfunction <optional>
The function to call if the operation fails. If none provided, the default driver callback is used.
-
authenticate(settings, Function)
-
Authenticates as the supplied user.
A user can either be authenticated using username/password credentials or via an authentication code.
Authorization Code flow:
{ "code": "
", "redirectUri": "" } Username/password flow: { "username": "
", "password": " " } Implicit flow:
{ "accessToken": "
", "redirectUri": " " } Using Gitana Ticket from a cookie:
{ "cookie": true }
Using Gitana Ticket (explicitly provided):
{ "ticket": "
" } An authentication failure handler can be passed as the final argument
Parameters:
Name Type Argument Description settingsObject Function<optional>
authentication failure handler
-
clearAuthentication()
-
Clears any authentication for the driver.
-
defaultFailureCallback()
-
Default AJAX failure callback
-
destroy()
-
Destructor function, called at the end of the driver instance's lifecycle
-
getAuthInfo()
-
Sets the authentication info
-
getLocale() → {String}
-
Retrieves the default locale being used by this driver.
Returns:
locale string
- Type
- String
-
gitanaDelete(url, params, successCallback, failureCallback)
-
Sends an HTTP DELETE request to the Gitana server.
Parameters:
Name Type Argument Description urlString Either a full URL (i.e. "http://server:port/uri") or a URI against the driver's server URL (i.e. /repositories/...)
paramsObject request parameters
successCallbackfunction <optional>
The function to call if the operation succeeds.
failureCallbackfunction <optional>
The function to call if the operation fails.
-
gitanaDownload(url, params, successCallback, failureCallback)
-
Sends an HTTP GET request to the Gitana server.
Parameters:
Name Type Argument Description urlString Either a full URL (i.e. "http://server:port/uri") or a URI against the driver's server URL (i.e. /repositories/...)
paramsObject request parameters
successCallbackfunction <optional>
The function to call if the operation succeeds.
failureCallbackfunction <optional>
The function to call if the operation fails.
-
gitanaGet(url, params, headers, successCallback, failureCallback)
-
Sends an HTTP GET request to the Gitana server.
Parameters:
Name Type Argument Description urlString Either a full URL (i.e. "http://server:port/uri") or a URI against the driver's server URL (i.e. /repositories/...)
paramsObject request parameters
headersObject request headers
successCallbackfunction <optional>
The function to call if the operation succeeds.
failureCallbackfunction <optional>
The function to call if the operation fails.
-
gitanaPost(url, params, jsonData, successCallback, failureCallback)
-
Sends an HTTP POST request to the Gitana server.
Parameters:
Name Type Argument Description urlString Either a full URL (i.e. "http://server:port/uri") or a URI against the driver's server URL (i.e. /repositories/...)
paramsObject request parameters
jsonDataObject <optional>
The JSON to plug into the payload.
successCallbackfunction <optional>
The function to call if the operation succeeds.
failureCallbackfunction <optional>
The function to call if the operation fails.
-
gitanaPut(url, params, jsonData, successCallback, failureCallback)
-
Sends an HTTP PUT request to the Gitana server.
Parameters:
Name Type Argument Description urlString Either a full URL (i.e. "http://server:port/uri") or a URI against the driver's server URL (i.e. /repositories/...)
paramsObject request parameters
jsonDataObject <optional>
The JSON to plug into the payload.
successCallbackfunction <optional>
The function to call if the operation succeeds.
failureCallbackfunction <optional>
The function to call if the operation fails.
-
gitanaRequest(method, url, params, String, data, successCallback, failureCallback)
-
Send an HTTP request via AJAX to the Gitana Server.
This method will additionally make sure of the following:
1) That the Gitana Driver authentication ticket is plugged onto the request. 2) That the Gitana Driver locale is plugged onto the request. 3) That full object data is returned (including metadata).
Parameters:
Name Type Argument Description methodString The kind of method to invoke - "get", "post", "put", or "del"
urlString Either a full URL (i.e. "http://server:port/uri") or a URI against the driver's server URL (i.e. /repositories/...)
paramsObject parameter map
String<optional>
contentType If the case of a payload carrying request (i.e. not GET), the content type being sent.
dataObject In the case of a payload carrying request (i.e. not GET), the JSON to plug into the payload.
successCallbackfunction <optional>
The function to call if the operation succeeds.
failureCallbackfunction <optional>
The function to call if the operation fails.
-
gitanaUpload(url, params, contentType, jsonData, successCallback, failureCallback)
-
Sends an HTTP POST request to the Gitana server.
Parameters:
Name Type Argument Description urlString Either a full URL (i.e. "http://server:port/uri") or a URI against the driver's server URL (i.e. /repositories/...)
paramsObject request parameters
contentTypeString content type being sent
jsonDataObject <optional>
The JSON to plug into the payload.
successCallbackfunction <optional>
The function to call if the operation succeeds.
failureCallbackfunction <optional>
The function to call if the operation fails.
-
refreshAuthentication(callback)
-
Refreshes the authentication access token.
Parameters:
Name Type Description callback -
setLocale(locale)
-
Sets the default locale for interactions with the Gitana server by this driver.
Parameters:
Name Type Description localeString locale string