com.segue.scc.published.api.vcs

Class SourceControlException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.segue.scc.published.api.vcs.SourceControlException

All Implemented Interfaces:

java.io.Serializable

public class SourceControlException
extends java.lang.Exception

Indicates an error when operating with a SourceControl system. This exception may be thrown directly, or a subclass of it, which is recommended for translating native error codes and others.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_CLIENT_API_NOT_FOUND A required sourceControl client API was not found.
static int	ERROR_FILE_TOO_LARGE
static int	ERROR_INVALID_ARGUMENT An argument provided to the SCS was invalid, for example missing.
static int	ERROR_LOCAL_FILE_STORAGE_FAIL
static int	ERROR_NO_VERSION_SUPPORT A label should be fetched but the profile does not support versioning (UNC).
static int	ERROR_NOT_IMPLEMENTED The method is not implemented.
static int	ERROR_PROJECT_DOESENT_EXIST The specified projectPath doesn't exist.
static int	ERROR_SECURITY_ISSUE Mostly wrong user or password.
static int	ERROR_TARGET_EXISTS
static int	ERROR_UNKNOWN An unknown (not exactly specified) error occurred.
static int	ERROR_VOID_PROFILE The SCP has void functionality

Constructor Summary

Constructors

Constructor and Description
SourceControlException(int vcsErrorCode)
SourceControlException(int vcsErrorCode, java.lang.Throwable cause)
SourceControlException(java.lang.String message, int vcsErrorCode)
SourceControlException(java.lang.String message, java.lang.Throwable cause)
SourceControlException(java.lang.String message, java.lang.Throwable cause, int vcsErrorCode)
SourceControlException(java.lang.Throwable cause)
SourceControlException(java.lang.Throwable cause, int vcsErrorCode)

Method Summary

Modifier and Type	Method and Description
int	getVcsErrorCode() For possible error codes, see the ERROR_* constants.
void	setVcsErrorCode(int vcsErrorCode)

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_INVALID_ARGUMENT

public static final int ERROR_INVALID_ARGUMENT

An argument provided to the SCS was invalid, for example missing.

See Also:

Constant Field Values

ERROR_SECURITY_ISSUE

public static final int ERROR_SECURITY_ISSUE

Mostly wrong user or password.

See Also:

Constant Field Values

ERROR_TARGET_EXISTS

public static final int ERROR_TARGET_EXISTS

See Also:

Constant Field Values

ERROR_CLIENT_API_NOT_FOUND

public static final int ERROR_CLIENT_API_NOT_FOUND

A required sourceControl client API was not found. This could be a command-line client that is used, a jar file, or a native library.

See Also:

Constant Field Values

ERROR_PROJECT_DOESENT_EXIST

public static final int ERROR_PROJECT_DOESENT_EXIST

The specified projectPath doesn't exist.

See Also:

Constant Field Values

ERROR_NOT_IMPLEMENTED

public static final int ERROR_NOT_IMPLEMENTED

The method is not implemented. This should not be used, because if something isn't implemented, the plugin should just behave as quiet as possible.

See Also:

Constant Field Values

ERROR_NO_VERSION_SUPPORT

public static final int ERROR_NO_VERSION_SUPPORT

A label should be fetched but the profile does not support versioning (UNC).

See Also:

Constant Field Values

ERROR_LOCAL_FILE_STORAGE_FAIL

public static final int ERROR_LOCAL_FILE_STORAGE_FAIL

See Also:

Constant Field Values

ERROR_VOID_PROFILE

public static final int ERROR_VOID_PROFILE

The SCP has void functionality

See Also:

Constant Field Values

ERROR_FILE_TOO_LARGE

public static final int ERROR_FILE_TOO_LARGE

See Also:

Constant Field Values

ERROR_UNKNOWN

public static final int ERROR_UNKNOWN

An unknown (not exactly specified) error occurred. If this is thrown, the message in the exception should contain something useful.

See Also:

Constant Field Values

Constructor Detail

SourceControlException

public SourceControlException(int vcsErrorCode)

SourceControlException

public SourceControlException(java.lang.String message,
                              int vcsErrorCode)

SourceControlException

public SourceControlException(java.lang.Throwable cause,
                              int vcsErrorCode)

SourceControlException

public SourceControlException(java.lang.String message,
                              java.lang.Throwable cause,
                              int vcsErrorCode)

SourceControlException

public SourceControlException(java.lang.Throwable cause)

SourceControlException

public SourceControlException(java.lang.String message,
                              java.lang.Throwable cause)

SourceControlException

public SourceControlException(int vcsErrorCode,
                              java.lang.Throwable cause)

Method Detail

getVcsErrorCode

public int getVcsErrorCode()

For possible error codes, see the ERROR_* constants.

setVcsErrorCode

public void setVcsErrorCode(int vcsErrorCode)