org.imsglobal.pox

Class IMSPOXRequest

java.lang.Object

org.imsglobal.pox.IMSPOXRequest

public class IMSPOXRequest
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
String	base_string
Element	bodyElement
String	errorMessage
Element	headerElement
static String	MAJOR_FAILURE
static String	MAJOR_PROCESSING
static String	MAJOR_SUCCESS
static String	MAJOR_UNSUPPORTED
static String	MINOR_DELETEFAILURE
static String	MINOR_FULLSUCCESS
static String	MINOR_IDALLOC
static String	MINOR_IDALLOCINUSEFAIL
static String	MINOR_INCOMPLETEDATA
static String	MINOR_INVALIDDATAFAIL
static String	MINOR_LINKFAILURE
static String	MINOR_NOSOURCEDIDS
static String	MINOR_OVERFLOWFAIL
static String	MINOR_PARTIALSTORAGE
static String	MINOR_SAVEPOINTERROR
static String	MINOR_SAVEPOINTSYNCERROR
static String	MINOR_TARGETISBUSY
static String	MINOR_TARGETREADFAILURE
static String	MINOR_UNAUTHORIZEDREQUEST
static String	MINOR_UNKNOWNEXTENSION
static String	MINOR_UNKNOWNOBJECT
static String	MINOR_UNKNOWNQUERY
static String	MINOR_UNKNOWNVOCAB
static String	MINOR_UNSUPPORTED
String	postBody
Document	postDom
static String	replaceResultMessage
static String	SEVERITY_ERROR
static String	SEVERITY_STATUS
static String	SEVERITY_WARNING
boolean	valid
static String[]	validMajor
static String[]	validMinor
static String[]	validSeverity

Constructor Summary

Constructors

Constructor and Description
IMSPOXRequest(javax.servlet.http.HttpServletRequest request)
IMSPOXRequest(String bodyString)
IMSPOXRequest(String oauth_consumer_key, String oauth_secret, javax.servlet.http.HttpServletRequest request)

Method Summary

Methods

Modifier and Type	Method and Description
static org.apache.http.client.methods.HttpPost	buildReplaceResult(String url, String key, String secret, String sourcedid, String score, String resultData, Boolean isUrl)
static String	fetchTag(Element element, String tag)
static String	getBodyHash(String postBody)
Map<String,String>	getBodyMap()
static String	getFatalResponse(String description)
static String	getFatalResponse(String description, String message_id)
String	getHeaderItem(String path)
Map<String,String>	getHeaderMap()
String	getHeaderMessageIdentifier()
String	getHeaderVersion()
String	getOAuthConsumerKey()
String	getOperation()
String	getPostBody()
String	getResponse(String description, String major, String severity, String messageId, Properties minor, String bodyString)
String	getResponseFailure(String desc, Properties minor)
String	getResponseFailure(String desc, Properties minor, String bodyString)
String	getResponseSuccess(String desc, String bodyString)
String	getResponseUnsupported(String desc)
boolean	inArray(String[] theArray, String theString)
void	loadFromRequest(javax.servlet.http.HttpServletRequest request)
void	parsePostBody()
static String	readPostBody(Reader in)
static void	sendReplaceResult(String url, String key, String secret, String sourcedid, String score)
static void	sendReplaceResult(String url, String key, String secret, String sourcedid, String score, String resultData)
static void	sendReplaceResult(String url, String key, String secret, String sourcedid, String score, String resultData, Boolean isUrl)
void	setAuthHeader(String header)
void	validatePostBody()
void	validateRequest(String oauth_consumer_key, String oauth_secret, javax.servlet.http.HttpServletRequest request)
void	validateRequest(String oauth_consumer_key, String oauth_secret, javax.servlet.http.HttpServletRequest request, String URL)

Methods inherited from class java.lang.Object

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

Field Detail

MAJOR_SUCCESS

public static final String MAJOR_SUCCESS

See Also:

Constant Field Values

MAJOR_FAILURE

public static final String MAJOR_FAILURE

See Also:

Constant Field Values

MAJOR_UNSUPPORTED

public static final String MAJOR_UNSUPPORTED

See Also:

Constant Field Values

MAJOR_PROCESSING

public static final String MAJOR_PROCESSING

See Also:

Constant Field Values

validMajor

public static final String[] validMajor

SEVERITY_ERROR

public static final String SEVERITY_ERROR

See Also:

Constant Field Values

SEVERITY_WARNING

public static final String SEVERITY_WARNING

See Also:

Constant Field Values

SEVERITY_STATUS

public static final String SEVERITY_STATUS

See Also:

Constant Field Values

validSeverity

public static final String[] validSeverity

MINOR_FULLSUCCESS

public static final String MINOR_FULLSUCCESS

See Also:

Constant Field Values

MINOR_NOSOURCEDIDS

public static final String MINOR_NOSOURCEDIDS

See Also:

Constant Field Values

MINOR_IDALLOC

public static final String MINOR_IDALLOC

See Also:

Constant Field Values

MINOR_OVERFLOWFAIL

public static final String MINOR_OVERFLOWFAIL

See Also:

Constant Field Values

MINOR_IDALLOCINUSEFAIL

public static final String MINOR_IDALLOCINUSEFAIL

See Also:

Constant Field Values

MINOR_INVALIDDATAFAIL

public static final String MINOR_INVALIDDATAFAIL

See Also:

Constant Field Values

MINOR_INCOMPLETEDATA

public static final String MINOR_INCOMPLETEDATA

See Also:

Constant Field Values

MINOR_PARTIALSTORAGE

public static final String MINOR_PARTIALSTORAGE

See Also:

Constant Field Values

MINOR_UNKNOWNOBJECT

public static final String MINOR_UNKNOWNOBJECT

See Also:

Constant Field Values

MINOR_DELETEFAILURE

public static final String MINOR_DELETEFAILURE

See Also:

Constant Field Values

MINOR_TARGETREADFAILURE

public static final String MINOR_TARGETREADFAILURE

See Also:

Constant Field Values

MINOR_SAVEPOINTERROR

public static final String MINOR_SAVEPOINTERROR

See Also:

Constant Field Values

MINOR_SAVEPOINTSYNCERROR

public static final String MINOR_SAVEPOINTSYNCERROR

See Also:

Constant Field Values

MINOR_UNKNOWNQUERY

public static final String MINOR_UNKNOWNQUERY

See Also:

Constant Field Values

MINOR_UNKNOWNVOCAB

public static final String MINOR_UNKNOWNVOCAB

See Also:

Constant Field Values

MINOR_TARGETISBUSY

public static final String MINOR_TARGETISBUSY

See Also:

Constant Field Values

MINOR_UNKNOWNEXTENSION

public static final String MINOR_UNKNOWNEXTENSION

See Also:

Constant Field Values

MINOR_UNAUTHORIZEDREQUEST

public static final String MINOR_UNAUTHORIZEDREQUEST

See Also:

Constant Field Values

MINOR_LINKFAILURE

public static final String MINOR_LINKFAILURE

See Also:

Constant Field Values

MINOR_UNSUPPORTED

public static final String MINOR_UNSUPPORTED

See Also:

Constant Field Values

validMinor

public static final String[] validMinor

postDom

public Document postDom

bodyElement

public Element bodyElement

headerElement

public Element headerElement

postBody

public String postBody

valid

public boolean valid

errorMessage

public String errorMessage

base_string

public String base_string

replaceResultMessage

public static final String replaceResultMessage

See Also:

Constant Field Values

Constructor Detail

IMSPOXRequest

public IMSPOXRequest(String oauth_consumer_key,
             String oauth_secret,
             javax.servlet.http.HttpServletRequest request)

IMSPOXRequest

public IMSPOXRequest(javax.servlet.http.HttpServletRequest request)

IMSPOXRequest

public IMSPOXRequest(String bodyString)

Method Detail

getOperation

public String getOperation()

getOAuthConsumerKey

public String getOAuthConsumerKey()

getHeaderVersion

public String getHeaderVersion()

getHeaderMessageIdentifier

public String getHeaderMessageIdentifier()

getHeaderItem

public String getHeaderItem(String path)

getHeaderMap

public Map<String,String> getHeaderMap()

getBodyMap

public Map<String,String> getBodyMap()

getPostBody

public String getPostBody()

loadFromRequest

public void loadFromRequest(javax.servlet.http.HttpServletRequest request)

setAuthHeader

public void setAuthHeader(String header)

readPostBody

public static String readPostBody(Reader in)
                           throws IOException

Throws:

IOException

getBodyHash

public static String getBodyHash(String postBody)
                          throws GeneralSecurityException

Throws:

GeneralSecurityException

validatePostBody

public void validatePostBody()

parsePostBody

public void parsePostBody()

validateRequest

public void validateRequest(String oauth_consumer_key,
                   String oauth_secret,
                   javax.servlet.http.HttpServletRequest request)

validateRequest

public void validateRequest(String oauth_consumer_key,
                   String oauth_secret,
                   javax.servlet.http.HttpServletRequest request,
                   String URL)

fetchTag

public static String fetchTag(Element element,
              String tag)

inArray

public boolean inArray(String[] theArray,
              String theString)

getFatalResponse

public static String getFatalResponse(String description)

getFatalResponse

public static String getFatalResponse(String description,
                      String message_id)

getResponseUnsupported

public String getResponseUnsupported(String desc)

getResponseFailure

public String getResponseFailure(String desc,
                        Properties minor)

getResponseFailure

public String getResponseFailure(String desc,
                        Properties minor,
                        String bodyString)

getResponseSuccess

public String getResponseSuccess(String desc,
                        String bodyString)

getResponse

public String getResponse(String description,
                 String major,
                 String severity,
                 String messageId,
                 Properties minor,
                 String bodyString)

sendReplaceResult

public static void sendReplaceResult(String url,
                     String key,
                     String secret,
                     String sourcedid,
                     String score)
                              throws IOException,
                                     oauth.signpost.exception.OAuthException,
                                     GeneralSecurityException

Throws:

IOException

oauth.signpost.exception.OAuthException

GeneralSecurityException

sendReplaceResult

public static void sendReplaceResult(String url,
                     String key,
                     String secret,
                     String sourcedid,
                     String score,
                     String resultData)
                              throws IOException,
                                     oauth.signpost.exception.OAuthException,
                                     GeneralSecurityException

Throws:

IOException

oauth.signpost.exception.OAuthException

GeneralSecurityException

sendReplaceResult

public static void sendReplaceResult(String url,
                     String key,
                     String secret,
                     String sourcedid,
                     String score,
                     String resultData,
                     Boolean isUrl)
                              throws IOException,
                                     oauth.signpost.exception.OAuthException,
                                     GeneralSecurityException

Throws:

IOException

oauth.signpost.exception.OAuthException

GeneralSecurityException

buildReplaceResult

public static org.apache.http.client.methods.HttpPost buildReplaceResult(String url,
                                                         String key,
                                                         String secret,
                                                         String sourcedid,
                                                         String score,
                                                         String resultData,
                                                         Boolean isUrl)
                                                                  throws IOException,
                                                                         oauth.signpost.exception.OAuthException,
                                                                         GeneralSecurityException

Throws:

IOException

oauth.signpost.exception.OAuthException

GeneralSecurityException