org.mitre.mat.engineclient
Class MATCgiClient

java.lang.Object
  org.mitre.mat.engineclient.MATCgiClient

All Implemented Interfaces:

MATEngineClientInterface

public class MATCgiClient
extends java.lang.Object
implements MATEngineClientInterface

The class which implements CGI interaction with the MAT engine.

Nested Class Summary

class	MATCgiClient.ContentTagInfo
class	MATCgiClient.WorkspaceFileResult

Field Summary

static java.lang.String	BAD_BOUNDARIES_VOTE
static java.lang.String	CORE_FOLDER
static java.lang.String	CROSSVALIDATION_CHALLENGE_PHASE
static java.lang.String	EXPORT_FOLDER
static java.lang.String	HUMAN_DECISION_PHASE
static java.lang.String	HUMAN_GOLD_SEGMENT_STATUS
static java.lang.String	HUMAN_VOTE_PHASE
static java.lang.String	IGNORE_DURING_RECONCILIATION_SEGMENT_STATUS
static java.lang.String	IGNORE_SEGMENT_STATUS
static java.lang.String	IGNORE_VOTE
static java.lang.String	NON_GOLD_SEGMENT_STATUS
static java.lang.String	RECONCILED_SEGMENT_STATUS
static java.lang.String	RECONCILIATION_FOLDER

Constructor Summary

MATCgiClient(java.lang.String urlHostAndPort)

Method Summary

protected void	checkReturnValueValidity(org.codehaus.jackson.JsonNode jsonValues)
protected MATCgiClient.WorkspaceFileResult	digestResult(org.codehaus.jackson.JsonNode jsonValues)
protected org.mitre.mat.core.MATDocumentInterface	doFileOperation(org.mitre.mat.core.MATDocumentInterface doc, java.lang.String task, java.lang.String workflow, java.lang.String op, java.lang.String opKey, java.lang.String opVal, java.util.HashMap<java.lang.String,java.lang.String> data)
org.mitre.mat.core.MATDocumentInterface	doSteps(org.mitre.mat.core.MATDocumentInterface doc, java.lang.String task, java.lang.String workflow, java.lang.String steps, java.util.HashMap<java.lang.String,java.lang.String> data)
MATCgiClient.WorkspaceFileResult	doToplevelWorkspaceOperation(java.lang.String workspaceDir, java.lang.String workspaceKey, java.lang.String operation, java.util.ArrayList<java.lang.String> args)
MATCgiClient.WorkspaceFileResult	doToplevelWorkspaceOperation(java.lang.String workspaceDir, java.lang.String workspaceKey, java.lang.String operation, java.util.ArrayList<java.lang.String> args, java.util.HashMap<java.lang.String,java.lang.String> data)
org.mitre.mat.core.MATDocumentInterface	doUndoThrough(org.mitre.mat.core.MATDocumentInterface doc, java.lang.String task, java.lang.String workflow, java.lang.String steps, java.util.HashMap<java.lang.String,java.lang.String> data)
MATCgiClient.WorkspaceFileResult	doWorkspaceOperation(java.lang.String workspaceDir, java.lang.String workspaceKey, java.lang.String folder, java.lang.String operation, java.lang.String basename)
MATCgiClient.WorkspaceFileResult	doWorkspaceOperation(java.lang.String workspaceDir, java.lang.String workspaceKey, java.lang.String folder, java.lang.String operation, java.lang.String basename, java.util.HashMap<java.lang.String,java.lang.String> data)
MATCgiClient.WorkspaceFileResult	importFileIntoWorkspace(java.lang.String workspaceDir, java.lang.String workspaceKey, java.lang.String folder, org.mitre.mat.core.MATDocumentInterface doc, java.lang.String basename, java.util.HashMap<java.lang.String,java.lang.String> data)
MATCgiClient.WorkspaceFileResult	listWorkspaceFolder(java.lang.String workspaceDir, java.lang.String workspaceKey, java.lang.String folder)
java.util.ArrayList<java.lang.String>	openWorkspace(java.lang.String workspaceDir, java.lang.String workspaceKey, java.lang.String user)
MATCgiClient.WorkspaceFileResult	openWorkspaceFile(java.lang.String workspaceDir, java.lang.String workspaceKey, java.lang.String folder, java.lang.String basename)
MATCgiClient.WorkspaceFileResult	openWorkspaceFile(java.lang.String workspaceDir, java.lang.String workspaceKey, java.lang.String folder, java.lang.String basename, java.util.HashMap<java.lang.String,java.lang.String> data)
protected org.codehaus.jackson.JsonNode	postHTTP(java.util.ArrayList<org.apache.commons.httpclient.NameValuePair> pArrayList, java.util.HashMap<java.lang.String,java.lang.String> data)

Methods inherited from class java.lang.Object

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

Field Detail

CORE_FOLDER

public static final java.lang.String CORE_FOLDER

See Also:

Constant Field Values

EXPORT_FOLDER

public static final java.lang.String EXPORT_FOLDER

See Also:

Constant Field Values

RECONCILIATION_FOLDER

public static final java.lang.String RECONCILIATION_FOLDER

See Also:

Constant Field Values

NON_GOLD_SEGMENT_STATUS

public static final java.lang.String NON_GOLD_SEGMENT_STATUS

See Also:

Constant Field Values

HUMAN_GOLD_SEGMENT_STATUS

public static final java.lang.String HUMAN_GOLD_SEGMENT_STATUS

See Also:

Constant Field Values

RECONCILED_SEGMENT_STATUS

public static final java.lang.String RECONCILED_SEGMENT_STATUS

See Also:

Constant Field Values

IGNORE_SEGMENT_STATUS

public static final java.lang.String IGNORE_SEGMENT_STATUS

See Also:

Constant Field Values

IGNORE_DURING_RECONCILIATION_SEGMENT_STATUS

public static final java.lang.String IGNORE_DURING_RECONCILIATION_SEGMENT_STATUS

See Also:

Constant Field Values

IGNORE_VOTE

public static final java.lang.String IGNORE_VOTE

See Also:

Constant Field Values

BAD_BOUNDARIES_VOTE

public static final java.lang.String BAD_BOUNDARIES_VOTE

See Also:

Constant Field Values

CROSSVALIDATION_CHALLENGE_PHASE

public static final java.lang.String CROSSVALIDATION_CHALLENGE_PHASE

See Also:

Constant Field Values

HUMAN_VOTE_PHASE

public static final java.lang.String HUMAN_VOTE_PHASE

See Also:

Constant Field Values

HUMAN_DECISION_PHASE

public static final java.lang.String HUMAN_DECISION_PHASE

See Also:

Constant Field Values

Constructor Detail

MATCgiClient

public MATCgiClient(java.lang.String urlHostAndPort)

Method Detail

doSteps

public org.mitre.mat.core.MATDocumentInterface doSteps(org.mitre.mat.core.MATDocumentInterface doc,
                                                       java.lang.String task,
                                                       java.lang.String workflow,
                                                       java.lang.String steps,
                                                       java.util.HashMap<java.lang.String,java.lang.String> data)
                                                throws MATEngineClientException

Throws:

MATEngineClientException

doUndoThrough

public org.mitre.mat.core.MATDocumentInterface doUndoThrough(org.mitre.mat.core.MATDocumentInterface doc,
                                                             java.lang.String task,
                                                             java.lang.String workflow,
                                                             java.lang.String steps,
                                                             java.util.HashMap<java.lang.String,java.lang.String> data)
                                                      throws MATEngineClientException

Throws:

MATEngineClientException

doFileOperation

protected org.mitre.mat.core.MATDocumentInterface doFileOperation(org.mitre.mat.core.MATDocumentInterface doc,
                                                                  java.lang.String task,
                                                                  java.lang.String workflow,
                                                                  java.lang.String op,
                                                                  java.lang.String opKey,
                                                                  java.lang.String opVal,
                                                                  java.util.HashMap<java.lang.String,java.lang.String> data)
                                                           throws MATEngineClientException

Throws:

MATEngineClientException

openWorkspace

public java.util.ArrayList<java.lang.String> openWorkspace(java.lang.String workspaceDir,
                                                           java.lang.String workspaceKey,
                                                           java.lang.String user)
                                                    throws MATEngineClientException

Throws:

MATEngineClientException

listWorkspaceFolder

public MATCgiClient.WorkspaceFileResult listWorkspaceFolder(java.lang.String workspaceDir,
                                                            java.lang.String workspaceKey,
                                                            java.lang.String folder)
                                                     throws MATEngineClientException

Throws:

MATEngineClientException

openWorkspaceFile

public MATCgiClient.WorkspaceFileResult openWorkspaceFile(java.lang.String workspaceDir,
                                                          java.lang.String workspaceKey,
                                                          java.lang.String folder,
                                                          java.lang.String basename)
                                                   throws MATEngineClientException

Throws:

MATEngineClientException

openWorkspaceFile

public MATCgiClient.WorkspaceFileResult openWorkspaceFile(java.lang.String workspaceDir,
                                                          java.lang.String workspaceKey,
                                                          java.lang.String folder,
                                                          java.lang.String basename,
                                                          java.util.HashMap<java.lang.String,java.lang.String> data)
                                                   throws MATEngineClientException

Throws:

MATEngineClientException

checkReturnValueValidity

protected void checkReturnValueValidity(org.codehaus.jackson.JsonNode jsonValues)
                                 throws MATEngineClientException

Throws:

MATEngineClientException

digestResult

protected MATCgiClient.WorkspaceFileResult digestResult(org.codehaus.jackson.JsonNode jsonValues)
                                                 throws MATEngineClientException

Throws:

MATEngineClientException

doWorkspaceOperation

public MATCgiClient.WorkspaceFileResult doWorkspaceOperation(java.lang.String workspaceDir,
                                                             java.lang.String workspaceKey,
                                                             java.lang.String folder,
                                                             java.lang.String operation,
                                                             java.lang.String basename)
                                                      throws MATEngineClientException

Throws:

MATEngineClientException

doWorkspaceOperation

public MATCgiClient.WorkspaceFileResult doWorkspaceOperation(java.lang.String workspaceDir,
                                                             java.lang.String workspaceKey,
                                                             java.lang.String folder,
                                                             java.lang.String operation,
                                                             java.lang.String basename,
                                                             java.util.HashMap<java.lang.String,java.lang.String> data)
                                                      throws MATEngineClientException

Throws:

MATEngineClientException

doToplevelWorkspaceOperation

public MATCgiClient.WorkspaceFileResult doToplevelWorkspaceOperation(java.lang.String workspaceDir,
                                                                     java.lang.String workspaceKey,
                                                                     java.lang.String operation,
                                                                     java.util.ArrayList<java.lang.String> args)
                                                              throws MATEngineClientException

Throws:

MATEngineClientException

doToplevelWorkspaceOperation

public MATCgiClient.WorkspaceFileResult doToplevelWorkspaceOperation(java.lang.String workspaceDir,
                                                                     java.lang.String workspaceKey,
                                                                     java.lang.String operation,
                                                                     java.util.ArrayList<java.lang.String> args,
                                                                     java.util.HashMap<java.lang.String,java.lang.String> data)
                                                              throws MATEngineClientException

Throws:

MATEngineClientException

importFileIntoWorkspace

public MATCgiClient.WorkspaceFileResult importFileIntoWorkspace(java.lang.String workspaceDir,
                                                                java.lang.String workspaceKey,
                                                                java.lang.String folder,
                                                                org.mitre.mat.core.MATDocumentInterface doc,
                                                                java.lang.String basename,
                                                                java.util.HashMap<java.lang.String,java.lang.String> data)
                                                         throws MATEngineClientException

Throws:

MATEngineClientException

postHTTP

protected org.codehaus.jackson.JsonNode postHTTP(java.util.ArrayList<org.apache.commons.httpclient.NameValuePair> pArrayList,
                                                 java.util.HashMap<java.lang.String,java.lang.String> data)
                                          throws MATEngineClientException

Throws:

MATEngineClientException