com.hpe.adm.nga.sdk

Class Octane

java.lang.Object

com.hpe.adm.nga.sdk.Octane

public class Octane
extends Object

This class represents the main Octane context. This context represents the following:

• Octane server
• Sharedspace id
• Workspace id
• Authentication object

This represents the following URL in the Octane REST API:

server_url:port/api/shared_spaces/[sharedspace_id]/workspaces/[workspace_id]

However if both the sharedspace and workspace ids are omitted the context will be assumed to be the space admin:

server_url:port/api/shared_spaces

If only the workspace id is omitted the context is assumed to be workspace admin

server_url:port/api/shared_spaces/[sharedspace_id]

The Octane class is instantialized using the Octane.Builder class. Once that instance has been obtained the Octane context can be used to create further entity, metadata, attachment contexts or to sign out of the server.

The Octane instance can be reused to create different contexts

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Octane.Builder This class is used to create an Octane instance for normal API usage.
static class	Octane.OctaneCustomSettings Octane settings holder containing lower level configurations
static class	Octane.OctaneInternalConfiguration Used to aggregate internal configurations that need to be passed around

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO_ENTITY
static long	NO_WORKSPACE_ID

Method Summary

Modifier and Type	Method and Description
AttachmentList	attachmentList() Creates a new attachmentList object.
<T extends TypedEntityList> T	entityList(Class<T> entityListClass) Creates a new TypedEntityList context.
EntityList	entityList(String entityName) Creates a new EntityList context.
Metadata	metadata() Creates a new Metadata object.
void	signOut() Signs out of the Octane server.

Methods inherited from class java.lang.Object

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

Field Detail

NO_WORKSPACE_ID

public static final long NO_WORKSPACE_ID

See Also:

Constant Field Values

NO_ENTITY

public static final String NO_ENTITY

See Also:

Constant Field Values

Method Detail

entityList

public EntityList entityList(String entityName)

Creates a new EntityList context. The entity name should be the collection name of the entity. For example defects, tests, releases

This method creates a new separate entity context each time that can be reused or used in parallel

By using NO_ENTITY this is set to be the admin context to get the list of spaces or workspaces

Parameters:

entityName - - The name of the entity as a collection

Returns:

A new EntityList object that list of entities

entityList

public <T extends TypedEntityList> T entityList(Class<T> entityListClass)

Creates a new TypedEntityList context. The class is the concrete instance of the TypedEntityList

Type Parameters:

T - The type of class

Parameters:

entityListClass - The class that is the instance of the TypedEntityList

Returns:

The instance that can then be set as the context

metadata

public Metadata metadata()

Creates a new Metadata object. This represents the following URL:

[workspace_url/metadata

This can then be used further to get metadata information from the server

Returns:

A new Metadata object that holds the metadata context

attachmentList

public AttachmentList attachmentList()

Creates a new attachmentList object. This returns the context for attachments. This is equivalent to
[workspace_url/attachments

Returns:

A new attachmentList object that holds the attachments context

signOut

public void signOut()

Signs out of the Octane server. Any cookies that are held are deleted