- cancel() - Method in class com.anaplan.client.Task
-
Send a request to the server to cancel the task.
- CellReader - Interface in com.anaplan.client
-
Abstract source of tabulated cell data.
- CellWriter - Interface in com.anaplan.client
-
Abstract sink for tabulated cell data.
- checkInitialized() - Method in class com.anaplan.client.Service
-
Check that the Service object is ready for use.
- checkResponse(HttpResponse) - Method in class com.anaplan.client.transport.ApacheHttpProvider
-
- checkResponse(HttpResponse, int) - Method in class com.anaplan.client.transport.ApacheHttpProvider
-
- clear() - Method in class com.anaplan.client.transport.ApacheHttpProvider.ApacheCredentialsProvider
-
- close() - Method in interface com.anaplan.client.CellReader
-
Complete the transfer.
- close() - Method in interface com.anaplan.client.CellWriter
-
Complete the transfer.
- close() - Method in class com.anaplan.client.JDBCCellReader
-
Complete the transfer.
- close() - Method in class com.anaplan.client.Service
-
Release any system resources associated with this instance.
- close() - Method in class com.anaplan.client.transport.ApacheHttpProvider
-
Release all resources acquired by this provider
- close() - Method in interface com.anaplan.client.transport.TransportProvider
-
Release all resources acquired by this provider
- close() - Method in class com.anaplan.client.transport.TransportProviderBase
-
- closeDown() - Static method in class com.anaplan.client.Program
-
Release any resources held by this class.
- ColumnMetadata - Class in com.anaplan.client
-
Carries information about a column in an export.
- ColumnMetadata(DataType, String) - Constructor for class com.anaplan.client.ColumnMetadata
-
- com.anaplan.client - package com.anaplan.client
-
Provides the Service class, representing a connection to the
Anaplan Connect server, along with associated classes representing accessible resources on the server.
- com.anaplan.client.serialization - package com.anaplan.client.serialization
-
Provides mechanisms for marshalling request data and unmarshalling response data
- com.anaplan.client.transport - package com.anaplan.client.transport
-
Provides mechanisms for communicating (normally via HTTP) with an Anaplan
API service server implementation.
- compress(byte[], int, int) - Method in class com.anaplan.client.transport.TransportProviderBase
-
Compress the content using GZip compression.
- Constants - Class in com.anaplan.client
-
- Constants() - Constructor for class com.anaplan.client.Constants
-
- createDefaultProvider() - Method in class com.anaplan.client.transport.TransportProviderFactory
-
Create a new default provider
- createHttpClient() - Method in class com.anaplan.client.transport.ApacheHttpProvider
-
- createProvider(String) - Method in class com.anaplan.client.transport.TransportProviderFactory
-
Create a new provider by name
- createServerFileImportDataSource(String, String) - Method in class com.anaplan.client.Model
-
Create a new file-backed import data source.
- createTask() - Method in class com.anaplan.client.TaskFactory
-
Create a new task on the server.
- createTask(TaskParameters) - Method in class com.anaplan.client.TaskFactory
-
Create a new task on the server.
- Credentials - Class in com.anaplan.client
-
Credentials for accessing the Anaplan API service.
- Credentials(String, String) - Constructor for class com.anaplan.client.Credentials
-
Create user/passphrase credentials for service authentication, or
simple/digest proxy authentication.
- Credentials(String, String, String, String) - Constructor for class com.anaplan.client.Credentials
-
Create user/passphrase credentials for NTLM proxy authentication.
- Credentials(X509Certificate) - Constructor for class com.anaplan.client.Credentials
-
Create credentials for service authentication using user certificates.
- Credentials.Scheme - Enum in com.anaplan.client
-
Represents an authentication method.
- generateType1Msg(String, String) - Method in class com.anaplan.client.transport.JCIFSEngine
- generateType3Msg(String, String, String, String, String) - Method in class com.anaplan.client.transport.JCIFSEngine
- get(String, String) - Method in class com.anaplan.client.transport.ApacheHttpProvider
-
Send a GET request to the server
- get(String, String) - Method in interface com.anaplan.client.transport.TransportProvider
-
Send a GET request to the server
- get(String, String) - Method in class com.anaplan.client.transport.TransportProviderBase
-
- getAction(String) - Method in class com.anaplan.client.Model
-
Retrieve a specific action.
- getAction(String, String, String) - Static method in class com.anaplan.client.Program
-
Locate a saved action on the server.
- getActions() - Method in class com.anaplan.client.Model
-
Retrieve a list of available actions.
- getCancelledBy() - Method in class com.anaplan.client.TaskStatus
-
Get the name of the user who cancelled the task, if different from
the user associated with this task.
- getCertificate() - Method in class com.anaplan.client.Credentials
-
Get the certificate
- getCertificate() - Static method in class com.anaplan.client.Program
-
Loads the X509 certificate to be used for authentication.
- getCertificatePath() - Static method in class com.anaplan.client.Program
-
Returns the certificate path set using setCertificatePath()
- getCode() - Method in class com.anaplan.client.NamedObject
-
Get the code for the object.
- getColumnCount() - Method in class com.anaplan.client.ExportMetadata
-
Get the column count.
- getColumnDataType() - Method in class com.anaplan.client.ColumnMetadata
-
Get the data type of the column.
- getContentType() - Method in class com.anaplan.client.serialization.GsonHandler
-
Return the content type produced/consumed.
- getContentType() - Method in interface com.anaplan.client.serialization.SerializationHandler
-
Return the content type produced/consumed.
- getCountry() - Method in class com.anaplan.client.ServerFile
-
Get the country of the locale used for file autodetection.
- getCredentials(AuthScope) - Method in class com.anaplan.client.transport.ApacheHttpProvider.ApacheCredentialsProvider
-
- getCurrentStep() - Method in class com.anaplan.client.TaskStatus
-
Get a description of current activity.
- getDataTypes() - Method in class com.anaplan.client.ExportMetadata
-
Get the data types of each column in order.
- getDebugLevel() - Method in class com.anaplan.client.transport.TransportProviderBase
-
- getDefaultHandler() - Method in class com.anaplan.client.serialization.SerializationHandlerFactory
-
Get the default handler
- getDelimiter() - Method in class com.anaplan.client.ExportMetadata
-
Get the text delimiter for text/CSV.
- getDelimiter() - Method in class com.anaplan.client.ServerFile
-
Get the delimiter character used to enclose column cell data.
- getDetails() - Method in class com.anaplan.client.TaskResult
-
Return an immutable list of detail objects.
- getDomain() - Method in class com.anaplan.client.Credentials
-
Get the domain.
- getDownloadCellReader() - Method in class com.anaplan.client.ServerFile
-
Create a
CellReader
implementation which will
download the content from the server.
- getDownloadStream() - Method in class com.anaplan.client.ServerFile
-
Create an InputStream implementation which will download the content from
the server.
- getEncoding() - Method in class com.anaplan.client.ExportMetadata
-
Get the text encoding for text/CSV.
- getEncoding() - Method in class com.anaplan.client.ServerFile
-
Get the character encoding used for the file.
- getExport(String) - Method in class com.anaplan.client.Model
-
Retrieve a specific export.
- getExport(String, String, String) - Static method in class com.anaplan.client.Program
-
Locate a saved export on the server.
- getExportFormat() - Method in class com.anaplan.client.ExportMetadata
-
Get the export format.
- getExportMetadata() - Method in class com.anaplan.client.Export
-
Get information about the columns in the export.
- getExports() - Method in class com.anaplan.client.Model
-
Retrieve the list of available exports.
- getFailureDump() - Method in class com.anaplan.client.TaskResult
-
Return a ServerFile containing the dump file which can be retrieved.
- getFirstDataRow() - Method in class com.anaplan.client.ServerFile
-
Get the row number of the first data row.
- getFormat() - Method in class com.anaplan.client.ServerFile
-
Get the format of the file.
- getHandler(String) - Method in class com.anaplan.client.serialization.SerializationHandlerFactory
-
Get a handler by name
- getHeaderName() - Method in class com.anaplan.client.ColumnMetadata
-
Get the header text for the column.
- getHeaderNames() - Method in class com.anaplan.client.ExportMetadata
-
Get the header names of each column in order.
- getHeaderRow() - Method in interface com.anaplan.client.CellReader
-
Return the header row.
- getHeaderRow() - Method in class com.anaplan.client.JDBCCellReader
-
Return the header row.
- getHeaderRow() - Method in class com.anaplan.client.ServerFile
-
Get the row number of the header row.
- getId() - Method in class com.anaplan.client.Model
-
Get the identifier of the model.
- getId() - Method in class com.anaplan.client.NamedObject
-
Get the Anaplan-generated identifier for the object.
- getId() - Method in class com.anaplan.client.Workspace
-
Get the identifier of the workspace.
- getImport(String) - Method in class com.anaplan.client.Model
-
Retrieve a specific import.
- getImport(String, String, String) - Static method in class com.anaplan.client.Program
-
Locate a import definition on the server.
- getImports() - Method in class com.anaplan.client.Model
-
Retrieve the list of available imports.
- getImportType() - Method in class com.anaplan.client.Import
-
Get the type of import.
- getInstance() - Static method in class com.anaplan.client.serialization.SerializationHandlerFactory
-
Get the singleton factory instance.
- getInstance() - Static method in class com.anaplan.client.transport.TransportProviderFactory
-
Get the singleton factory instance.
- getKeyStoreAlias() - Static method in class com.anaplan.client.Program
-
Returns the key store alias set using setKeyStoreAlias()
- getKeyStorePassword() - Static method in class com.anaplan.client.Program
-
Returns the key store password set using setKeyStorePassword().
- getKeyStorePath() - Static method in class com.anaplan.client.Program
-
Returns the key store path set using setKeyStorePath()
- getLabel() - Method in enum com.anaplan.client.DataType
-
Return an identifier for the data type.
- getLanguage() - Method in class com.anaplan.client.ServerFile
-
Get the language of the locale used for file autodetection.
- getListNames() - Method in class com.anaplan.client.ExportMetadata
-
Get the names of lists applicable to each column in order.
- getLocalizedMessageText() - Method in class com.anaplan.client.TaskResultDetail
-
Get the localized message text.
- getMessage(String, Object...) - Method in class com.anaplan.client.transport.HttpProvider
-
Get a localized message for the given key.
- getModel(String, String) - Static method in class com.anaplan.client.Program
-
Locate a model on the server.
- getModel(String) - Method in class com.anaplan.client.Workspace
-
Retrieve a specific model by identifier.
- getModels() - Method in class com.anaplan.client.Workspace
-
Retrieve the list of available models.
- getModule(String) - Method in class com.anaplan.client.Model
-
Retrieve a specific module.
- getModule(String, String, String) - Static method in class com.anaplan.client.Program
-
Locate a module on the server.
- getModules() - Method in class com.anaplan.client.Model
-
Retrieve the list of available modules.
- getName() - Method in class com.anaplan.client.Model
-
Get the name of the model.
- getName() - Method in class com.anaplan.client.NamedObject
-
Get the name of the object.
- getName() - Method in class com.anaplan.client.Workspace
-
Get the name of the workspace.
- getNestedResults() - Method in class com.anaplan.client.TaskResult
-
Return an immutable List of nested TaskResults, one for each nested operation.
- getObjectId() - Method in class com.anaplan.client.TaskResult
-
Return the ID of the object to which this result pertains.
- getObjectName() - Method in class com.anaplan.client.TaskResult
-
Return the name of the object to which this result pertains.
- getOccurrences() - Method in class com.anaplan.client.TaskResultDetail
-
Get the number of occurrences.
- getPassphrase() - Method in class com.anaplan.client.Credentials
-
Get the passphrase.
- getPassphrase() - Static method in class com.anaplan.client.Program
-
Returns the password set using setPassword().
- getPort(URI) - Method in class com.anaplan.client.transport.HttpProvider
-
Extract the port from a URI.
- getProcess(String) - Method in class com.anaplan.client.Model
-
Retrieve a specific process.
- getProcess(String, String, String) - Static method in class com.anaplan.client.Program
-
Locate a process definition on the server.
- getProcesses() - Method in class com.anaplan.client.Model
-
Retrieve a list of available processes.
- getProgress() - Method in class com.anaplan.client.TaskStatus
-
Get an estimate of task completion.
- getProxyCredentials() - Static method in class com.anaplan.client.Program
-
Gathers the proxy credentials if set.
- getProxyCredentials() - Method in class com.anaplan.client.transport.TransportProviderBase
-
- getProxyLocation() - Method in class com.anaplan.client.transport.TransportProviderBase
-
- getProxyPassphrase() - Static method in class com.anaplan.client.Program
-
Returns the proxy password set using setProxyPassword().
- getProxySelector() - Method in class com.anaplan.client.transport.TransportProviderBase
-
- getProxyUsername() - Static method in class com.anaplan.client.Program
-
Returns the proxy username set using setProxyUsername().
- getRequestPath(String) - Method in class com.anaplan.client.transport.TransportProviderBase
-
Build a sanitized path relative to the service location.
- getResult() - Method in class com.anaplan.client.TaskStatus
-
Get the result of a completed task.
- getRowCount() - Method in class com.anaplan.client.ExportMetadata
-
Get the row count.
- getScheme() - Method in class com.anaplan.client.Credentials
-
Get the authentication method.
- getSeparator() - Method in class com.anaplan.client.ExportMetadata
-
Get the column separator character for text.
- getSeparator() - Method in class com.anaplan.client.ServerFile
-
Get the separator character(s) used to separate columns.
- getServerFile(String) - Method in class com.anaplan.client.Model
-
Retrieve a specific server file.
- getServerFile(String, String, String, boolean) - Static method in class com.anaplan.client.Program
-
Locate or optionally create a server file on the server.
- getServerFiles() - Method in class com.anaplan.client.Model
-
Retrieve the list of available server files.
- getService() - Static method in class com.anaplan.client.Program
-
Returns the client service instance.
- getServiceCredentials() - Static method in class com.anaplan.client.Program
-
Gathers the Anaplan service credentials.
- getServiceCredentials() - Method in class com.anaplan.client.transport.TransportProviderBase
-
- getServiceLocation() - Method in class com.anaplan.client.transport.TransportProviderBase
-
- getSourceFileId() - Method in class com.anaplan.client.Import
-
Get the ID of the data source associated with the import, if it is an uploaded file.
- getStatus() - Method in class com.anaplan.client.Task
-
Get the current status of the task.
- getStatusMessage(int, String) - Method in class com.anaplan.client.transport.HttpProvider
-
Get a localized message for the HTTP status code
- getTasks() - Method in class com.anaplan.client.TaskFactory
-
Get a list of all server tasks associated with this object.
- getTaskState() - Method in class com.anaplan.client.TaskStatus
-
Get the task's state.
- getType() - Method in class com.anaplan.client.serialization.TypeWrapper
-
Return an instance of Type representing the type.
- getType() - Method in class com.anaplan.client.TaskResultDetail
-
Get the type of detail.
- getUploadCellWriter() - Method in class com.anaplan.client.ServerFile
-
Return a
CellWriter
implementation which will
upload written content to the server, writing it to the specified target
file.
- getUploadStream() - Method in class com.anaplan.client.ServerFile
-
Return a new OutputStream implementation which will upload written
content to the server, writing it to the specified target file.
- getUserAgent() - Method in class com.anaplan.client.transport.TransportProviderBase
-
- getUserName() - Method in class com.anaplan.client.Credentials
-
Get the user name.
- getUsername() - Static method in class com.anaplan.client.Program
-
Returns the username set using setUsername().
- getValues() - Method in class com.anaplan.client.TaskResultDetail
-
Get any additional information as key/value pairs.
- getView(String) - Method in class com.anaplan.client.Module
-
Retrieve a specific view.
- getView(String, String, String, String) - Static method in class com.anaplan.client.Program
-
Locate a saved view on the server.
- getViews() - Method in class com.anaplan.client.Module
-
Retrieve a list of available views.
- getWorkspace(String) - Static method in class com.anaplan.client.Program
-
Locate a workspace on the server.
- getWorkspace(String) - Method in class com.anaplan.client.Service
-
Retrieve a reference to a workspace from its workspaceId.
- getWorkspaces() - Method in class com.anaplan.client.Service
-
Retrieves the list of available workspaces.
- getWorkstation() - Method in class com.anaplan.client.Credentials
-
Get the workstation name.
- GsonHandler - Class in com.anaplan.client.serialization
-
SerializationHandler implementation using Google's GSON library.
- GsonHandler() - Constructor for class com.anaplan.client.serialization.GsonHandler
-
- SerializationHandler - Interface in com.anaplan.client.serialization
-
Represents a means of (un)marshalling parameters and results
- SerializationHandlerFactory - Class in com.anaplan.client.serialization
-
Registry of SerializationHandler implementations
- serialize(T, TypeWrapper<T>) - Method in class com.anaplan.client.serialization.GsonHandler
-
Serialize the request body of the specified type
- serialize(T, TypeWrapper<T>) - Method in interface com.anaplan.client.serialization.SerializationHandler
-
Serialize the request body of the specified type
- ServerFile - Class in com.anaplan.client
-
Represents a file on the Anaplan server associated with a model.
- ServerFile.Format - Enum in com.anaplan.client
-
File formats recognised by Ananplan import.
- Service - Class in com.anaplan.client
-
An authenticated connection to the Anaplan API service.
- Service(URI) - Constructor for class com.anaplan.client.Service
-
Create a new service client with the specified endpoint.
- Service() - Constructor for class com.anaplan.client.Service
-
Create a new service client for Anaplan's Production API Service.
- setCertificatePath(String) - Static method in class com.anaplan.client.Program
-
Set the path to the certificate
- setCountry(String) - Method in class com.anaplan.client.ServerFile
-
Set the country of the locale used for file autodetection.
- setCredentials(AuthScope, Credentials) - Method in class com.anaplan.client.transport.ApacheHttpProvider.ApacheCredentialsProvider
-
- setDebugLevel(int) - Static method in class com.anaplan.client.Program
-
Set the debug level.
- setDebugLevel(int) - Method in class com.anaplan.client.Service
-
Override the debug level.
- setDebugLevel(int) - Method in interface com.anaplan.client.transport.TransportProvider
-
Set the extent to which debug messages are produced
- setDebugLevel(int) - Method in class com.anaplan.client.transport.TransportProviderBase
-
Set the extent to which debug messages are produced
- setDelimiter(String) - Method in class com.anaplan.client.ServerFile
-
Set the delimiter character used to enclose column cell data.
- setEncoding(String) - Method in class com.anaplan.client.ServerFile
-
Set the character encoding used for the file.
- setFirstDataRow(Integer) - Method in class com.anaplan.client.ServerFile
-
Set the row number of the first data row.
- setFormat(ServerFile.Format) - Method in class com.anaplan.client.ServerFile
-
Set the format of the file.
- setHeaderRow(Integer) - Method in class com.anaplan.client.ServerFile
-
Set the row number of the header row.
- setKeyStoreAlias(String) - Static method in class com.anaplan.client.Program
-
Set the alias of the key store entry referring to the public
certificate and private key pair used by the client to authenticate
with the server
- setKeyStorePassword(String) - Static method in class com.anaplan.client.Program
-
Set the password of the key store
- setKeyStorePath(String) - Static method in class com.anaplan.client.Program
-
Set the path to the key store
- setLanguage(String) - Method in class com.anaplan.client.ServerFile
-
Set the language of the locale used for file autodetection.
- setLocale(String, String) - Method in class com.anaplan.client.TaskParameters
-
Set the locale to be used.
- setPassphrase(String) - Static method in class com.anaplan.client.Program
-
Set the passphrase of the Anaplan account for the service to use.
- setProxyCredentials(Credentials) - Method in class com.anaplan.client.Service
-
Set the user credentials for proxy authentication.
- setProxyCredentials(Credentials) - Method in interface com.anaplan.client.transport.TransportProvider
-
Set the credentials for a proxy requiring authentication
- setProxyCredentials(Credentials) - Method in class com.anaplan.client.transport.TransportProviderBase
-
Set the credentials for a proxy requiring authentication
- setProxyLocation(URI) - Static method in class com.anaplan.client.Program
-
Set the proxy location.
- setProxyLocation(URI) - Method in class com.anaplan.client.Service
-
Set the location of a proxy.
- setProxyLocation(URI) - Method in class com.anaplan.client.transport.ApacheHttpProvider
-
Route requests through a proxy server.
- setProxyLocation(URI) - Method in interface com.anaplan.client.transport.TransportProvider
-
Route requests through a proxy server.
- setProxyLocation(URI) - Method in class com.anaplan.client.transport.TransportProviderBase
-
Route requests through a proxy server.
- setProxyPassphrase(String) - Static method in class com.anaplan.client.Program
-
Set the passphrase for an authenticating proxy
- setProxyUsername(String) - Static method in class com.anaplan.client.Program
-
Set the username for an authenticating proxy
- setSeparator(String) - Method in class com.anaplan.client.ServerFile
-
Set the separator character(s) used to separate columns.
- setSerializationHandler(SerializationHandler) - Method in class com.anaplan.client.Service
-
Override the serialization handler to be used.
- setServiceCredentials(Credentials) - Method in class com.anaplan.client.Service
-
Set the user credentials for service authentication.
- setServiceCredentials(Credentials) - Method in class com.anaplan.client.transport.ApacheHttpProvider
-
Set the service credentials
- setServiceCredentials(Credentials) - Method in interface com.anaplan.client.transport.TransportProvider
-
Set the service credentials
- setServiceCredentials(Credentials) - Method in class com.anaplan.client.transport.TransportProviderBase
-
Set the service credentials
- setServiceLocation(URI) - Static method in class com.anaplan.client.Program
-
Set the service location.
- setServiceLocation(URI) - Method in class com.anaplan.client.transport.ApacheHttpProvider
-
Set the service endpoint location
- setServiceLocation(URI) - Method in interface com.anaplan.client.transport.TransportProvider
-
Set the service endpoint location
- setServiceLocation(URI) - Method in class com.anaplan.client.transport.TransportProviderBase
-
Set the service endpoint location
- setTransportProvider(TransportProvider) - Method in class com.anaplan.client.Service
-
Override the transport provider to be used.
- setUserAgent(String) - Method in class com.anaplan.client.transport.ApacheHttpProvider
-
Set the content of the User-Agent header to be passed to the server.
- setUserAgent(String) - Method in interface com.anaplan.client.transport.TransportProvider
-
Set the content of the User-Agent header to be passed to the server.
- setUserAgent(String) - Method in class com.anaplan.client.transport.TransportProviderBase
-
Set the content of the User-Agent header to be passed to the server.
- setUsername(String) - Static method in class com.anaplan.client.Program
-
Set the username of the Anaplan account for the service to use.