com.versionone.om

Class V1Instance

java.lang.Object

com.versionone.om.V1Instance

public class V1Instance
extends Object

Provides access to a single instance of a VersionOne application. This is the starting point for any application.

Constructor Summary

Constructors

Constructor and Description
V1Instance(String applicationPath) Initialize a V1Instance to communicate with an installation of VersionOne at a given URL using Integrated Authentication.
V1Instance(String applicationPath, String userName, String password) Initialize a V1Instance to communicate with an installation of VersionOne at a given URL using basic authentication.
V1Instance(String applicationPath, String userName, String password, ProxySettings proxySettings) Initialize a V1Instance to communicate with an installation of VersionOne through a proxy

Method Summary

Methods

Modifier and Type	Method and Description
V1InstanceCreator	create()
V1InstanceGetter	get()
ApiClientInternals	getApiClient() Allows access to the underlying API Client structures.
com.versionone.apiclient.Asset	getAsset(Object id) Retrieve an asset stored in asset cache.
InstanceConfiguration	getConfiguration()
CookiesManager	getCookiesJar() Cookies manager for working with cookies which send to the VersionOne server.
Map<String,String>	getCustomHttpHeaders() Http headers list for sending to the VersionOne key - name of parameter value - value of parameter
<T extends ListValue> T	getListValueByName(Class<T> clazz, String value)
Member	getLoggedInMember()
Collection<Member>	getMembers()
Collection<Project>	getProjects()
Object	getPropertyOnCustomType(CustomListValue entity, String name, boolean cachable)
Collection<Team>	getTeams()
Collection<TestSuite>	getTestSuites()
boolean	isValidationEnabled()
void	setApiClient(ApiClientInternals apiClient)
void	setAsset(Object id, com.versionone.apiclient.Asset asset)
void	setValidationEnabled(boolean status)
void	validate() Validate the application path, user name and password used to construct this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

V1Instance

public V1Instance(String applicationPath)

Initialize a V1Instance to communicate with an installation of VersionOne at a given URL using Integrated Authentication.

Parameters:

applicationPath - Location of the VersionOne application. Ex: http://server/versionone/

V1Instance

public V1Instance(String applicationPath,
          String userName,
          String password)

Initialize a V1Instance to communicate with an installation of VersionOne at a given URL using basic authentication.

Parameters:

applicationPath - Location of the VersionOne application. Ex: http://server/versionone/

userName - VersionOne member's user name to authenticate with. If using Integrated Authentication, must be in "user@domain" format.

password - VersionOne member's password to authenticate with.

V1Instance

public V1Instance(String applicationPath,
          String userName,
          String password,
          ProxySettings proxySettings)

Initialize a V1Instance to communicate with an installation of VersionOne through a proxy

Parameters:

applicationPath - Location of the VersionOne application. Ex: http://server/versionone/

userName - VersionOne member's user name to authenticate with. If using Integrated Authentication, must be in "user@domain" format.

password - VersionOne member's password to authenticate with.

proxySettings - Settings for proxy to connect to VersionOne application.

Method Detail

getCustomHttpHeaders

public Map<String,String> getCustomHttpHeaders()

Http headers list for sending to the VersionOne key - name of parameter value - value of parameter

Returns:

http headers lists

getCookiesJar

public CookiesManager getCookiesJar()

Cookies manager for working with cookies which send to the VersionOne server.

Returns:

cookies manager.

validate

public void validate()
              throws AuthenticationException,
                     ApplicationUnavailableException

Validate the application path, user name and password used to construct this instance.

Throws:

ApplicationUnavailableException - The application path is unavailable or invalid.

AuthenticationException - The supplied user name or password was invalid.

getConfiguration

public InstanceConfiguration getConfiguration()
                                       throws ApplicationUnavailableException,
                                              SDKException

Returns:

configuration settings for the VersionOne application instance.

Throws:

ApplicationUnavailableException - if any connection problems occur

SDKException - if any problems occur with reading settings

isValidationEnabled

public boolean isValidationEnabled()

Returns:

true if validator for required fields enabled

setValidationEnabled

public void setValidationEnabled(boolean status)

Parameters:

status - Required validator fields status

getLoggedInMember

public Member getLoggedInMember()

Returns:

the currently logged in member.

getProjects

public Collection<Project> getProjects()

Returns:

a read-only collection of root level Project entities.

getMembers

public Collection<Member> getMembers()

Returns:

a read-only collection of enumerable of Member entities.

getTeams

public Collection<Team> getTeams()

Returns:

a read-only collection of Team entities.

getTestSuites

public Collection<TestSuite> getTestSuites()

Returns:

a read-only collection of TestSuites.

getApiClient

public ApiClientInternals getApiClient()

Allows access to the underlying API Client structures. Only use this when you need access that this library does not provide.

Returns:

object used to access API Client methods.

setApiClient

public void setApiClient(ApiClientInternals apiClient)

Parameters:

apiClient - used by all SDK classes to access to API Client.

getAsset

public com.versionone.apiclient.Asset getAsset(Object id)

Retrieve an asset stored in asset cache.

Parameters:

id - asset will be found by.

Returns:

an Asset or null if the asset cannot be found in the cache.

setAsset

public void setAsset(Object id,
            com.versionone.apiclient.Asset asset)

getListValueByName

public <T extends ListValue> T getListValueByName(Class<T> clazz,
                                         String value)

getPropertyOnCustomType

public Object getPropertyOnCustomType(CustomListValue entity,
                             String name,
                             boolean cachable)
                               throws SDKException

Throws:

SDKException

get

public V1InstanceGetter get()

Returns:

Getter for various assets in the system.

create

public V1InstanceCreator create()

Returns:

Creator for various assets in the system.