META-INF.apidocs.nl.hsac.fitnesse.fixture.slim.JsonHttpTest.json Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hsac-fitnesse-fixtures Show documentation
Show all versions of hsac-fitnesse-fixtures Show documentation
Fixtures to assist in testing via FitNesse
{
"constructors" : [ {
"readableName" : "json http test",
"usage" : "| json http test |",
"name" : "JsonHttpTest",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ]
} ],
"qualifiedName" : "nl.hsac.fitnesse.fixture.slim.JsonHttpTest",
"publicMethods" : [ {
"readableName" : "post values as json to",
"usage" : "| post values as json to | [serviceUrl] | ",
"contexthelp" : "post values as json to <serviceUrl>",
"name" : "postValuesAsJsonTo",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "serviceUrl",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "put values as json to",
"usage" : "| put values as json to | [serviceUrl] | ",
"contexthelp" : "put values as json to <serviceUrl>",
"name" : "putValuesAsJsonTo",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "serviceUrl",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "delete with values as json",
"usage" : "| delete with values as json | [serviceUrl] | ",
"contexthelp" : "delete with values as json <serviceUrl>",
"name" : "deleteWithValuesAsJson",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "serviceUrl",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "json path",
"usage" : "| json path | [path] | ",
"contexthelp" : "json path <path>",
"name" : "jsonPath",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "path",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "Object"
}, {
"readableName" : "create file from base 64 content of",
"usage" : "| create file from base 64 content | [baseName] | of | [jsonPath] | ",
"contexthelp" : "create file from base 64 content <baseName> of <jsonPath>",
"name" : "createFileFromBase64ContentOf",
"docString" : "@param baseName base of filename to generate (a number might be added to the name to make it unique).\n@param jsonPath expression to evaluate.\n@return link to created file.",
"annotations" : [ ],
"parameters" : [ {
"name" : "baseName",
"description" : "base of filename to generate (a number might be added to the name to make it unique).",
"type" : "String"
}, {
"name" : "jsonPath",
"description" : "expression to evaluate.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "element of json path",
"usage" : "| element of json | [index] | path | [path] | ",
"contexthelp" : "element of json <index> path <path>",
"name" : "elementOfJsonPath",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "index",
"type" : "int"
}, {
"name" : "path",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "Object"
}, {
"readableName" : "json path count",
"usage" : "| json path count | [path] | ",
"contexthelp" : "json path count <path>",
"name" : "jsonPathCount",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "path",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "list json path matches",
"usage" : "| list json path matches | [path] | ",
"contexthelp" : "list json path matches <path>",
"name" : "listJsonPathMatches",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "path",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "ArrayList<Object>"
}, {
"readableName" : "all json path matches",
"usage" : "| all json path matches | [expr] | ",
"contexthelp" : "all json path matches <expr>",
"name" : "allJsonPathMatches",
"docString" : "Gets a HTML list with all matches to the supplied JsonPath.\n@param expr expression to evaluate.\n@return list containing all results of expression evaluation against last response received, null if there were no matches.\n@throws RuntimeException if no valid response was available or Json Path could not be evaluated.",
"annotations" : [ ],
"parameters" : [ {
"name" : "expr",
"description" : "expression to evaluate.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "set json path to",
"usage" : "| set json path | [path] | to | [value] | ",
"contexthelp" : "set json path <path> to <value>",
"name" : "setJsonPathTo",
"docString" : "Update a value in a the response by supplied jsonPath\n@param path the jsonPath to locate the key whose value needs changing\n@param value the new value to set",
"annotations" : [ ],
"parameters" : [ {
"name" : "path",
"description" : "the jsonPath to locate the key whose value needs changing",
"type" : "String"
}, {
"name" : "value",
"description" : "the new value to set",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "repeat until json path is",
"usage" : "| repeat until json path | [jsonPath] | is | [expectedValue] | ",
"contexthelp" : "repeat until json path <jsonPath> is <expectedValue>",
"name" : "repeatUntilJsonPathIs",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "jsonPath",
"type" : "String"
}, {
"name" : "expectedValue",
"type" : "Object"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "json path exists",
"usage" : "| json path exists | [path] | ",
"contexthelp" : "json path exists <path>",
"name" : "jsonPathExists",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "path",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "set throw exception on http request failure",
"usage" : "| set throw exception on http request failure | [throwException] | ",
"contexthelp" : "set throw exception on http request failure <throwException>",
"name" : "setThrowExceptionOnHttpRequestFailure",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "throwException",
"type" : "boolean"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "get throw exception on http request failure",
"usage" : "| get throw exception on http request failure |",
"contexthelp" : "get throw exception on http request failure",
"name" : "getThrowExceptionOnHttpRequestFailure",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "template",
"usage" : "| template | [aTemplate] | ",
"contexthelp" : "template <aTemplate>",
"name" : "template",
"docString" : "Sets template to use.\n@param aTemplate name of template file (relative to 'templates' directory on classpath)\n@return true if template could be found.",
"annotations" : [ ],
"parameters" : [ {
"name" : "aTemplate",
"description" : "name of template file (relative to 'templates' directory on classpath)",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "enable compression",
"usage" : "| enable compression |",
"contexthelp" : "enable compression",
"name" : "enableCompression",
"docString" : "Enables content compression support in the current environment (i.e. for the entire test run)\n@deprecated use {@link HttpClientSetup} to configure http client",
"annotations" : [ "Deprecated" ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "disable compression",
"usage" : "| disable compression |",
"contexthelp" : "disable compression",
"name" : "disableCompression",
"docString" : "Disables content compression support in the current environment (i.e. for the entire test run)\n@deprecated use {@link HttpClientSetup} to configure http client",
"annotations" : [ "Deprecated" ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "disable ssl verification",
"usage" : "| disable ssl verification |",
"contexthelp" : "disable ssl verification",
"name" : "disableSSLVerification",
"docString" : "Disables SSL certificate verification in the current environment (i.e. for the entire test run)\n@deprecated use {@link HttpClientSetup} to configure http client",
"annotations" : [ "Deprecated" ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "enable ssl verification",
"usage" : "| enable ssl verification |",
"contexthelp" : "enable ssl verification",
"name" : "enableSSLVerification",
"docString" : "Enables SSL certificate verification in the current environment (i.e. for the entire test run)\n@deprecated use {@link HttpClientSetup} to configure http client",
"annotations" : [ "Deprecated" ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set value for header",
"usage" : "| set value for | [value] | header | [name] | ",
"contexthelp" : "set value for <value> header <name>",
"name" : "setValueForHeader",
"docString" : "Stores value to be passed as headers.\n@param value value to be passed.\n@param name name to use this value for.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to be passed.",
"type" : "Object"
}, {
"name" : "name",
"description" : "name to use this value for.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "clear header value",
"usage" : "| clear header value | [name] | ",
"contexthelp" : "clear header value <name>",
"name" : "clearHeaderValue",
"docString" : "Clears a header value previously set.\n@param name value to remove.\n@return true if value was present.",
"annotations" : [ ],
"parameters" : [ {
"name" : "name",
"description" : "value to remove.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "clear header values",
"usage" : "| clear header values |",
"contexthelp" : "clear header values",
"name" : "clearHeaderValues",
"docString" : "Clears all header values previously set.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "copy header values from",
"usage" : "| copy header values from | [map] | ",
"contexthelp" : "copy header values from <map>",
"name" : "copyHeaderValuesFrom",
"docString" : "Adds all values in the supplied map to the current header values.\n@param map to obtain values from.",
"annotations" : [ ],
"parameters" : [ {
"name" : "map",
"description" : "to obtain values from.",
"type" : "Map<Object>"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "reset",
"usage" : "| reset |",
"contexthelp" : "reset",
"name" : "reset",
"docString" : "Called before next row is executed. (Clears all current and header values.)",
"annotations" : [ "Override" ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set",
"usage" : "| set | key, value, |",
"contexthelp" : "set key, value,",
"name" : "set",
"docString" : "Sets a value.\n@param key (possibly nested) key to set value for.\n@param value value to be stored.",
"annotations" : [ ],
"parameters" : [ {
"name" : "key",
"description" : "(possibly nested) key to set value for.",
"type" : "String"
}, {
"name" : "value",
"description" : "value to be stored.",
"type" : "Object"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "post template to",
"usage" : "| post template to | [serviceUrl] | ",
"contexthelp" : "post template to <serviceUrl>",
"name" : "postTemplateTo",
"docString" : "Sends HTTP POST template with current values to service endpoint.\n@param serviceUrl service endpoint to send request to.\n@return true if call could be made and response did not indicate error.",
"annotations" : [ ],
"parameters" : [ {
"name" : "serviceUrl",
"description" : "service endpoint to send request to.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "post template to",
"usage" : "| post template | [serviceUrl] | to | [aContentType] | ",
"contexthelp" : "post template <serviceUrl> to <aContentType>",
"name" : "postTemplateTo",
"docString" : "Sends HTTP POST template with current values to service endpoint.\n@param serviceUrl service endpoint to send request to.\n@param aContentType content type to use for post.\n@return true if call could be made and response did not indicate error.",
"annotations" : [ ],
"parameters" : [ {
"name" : "serviceUrl",
"description" : "service endpoint to send request to.",
"type" : "String"
}, {
"name" : "aContentType",
"description" : "content type to use for post.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "post to",
"usage" : "| post | [body] | to | [serviceUrl] | ",
"contexthelp" : "post <body> to <serviceUrl>",
"name" : "postTo",
"docString" : "Sends HTTP POST body to service endpoint.\n@param body content to post\n@param serviceUrl service endpoint to send body to.\n@return true if call could be made and response did not indicate error.",
"annotations" : [ ],
"parameters" : [ {
"name" : "body",
"description" : "content to post",
"type" : "String"
}, {
"name" : "serviceUrl",
"description" : "service endpoint to send body to.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "delete with",
"usage" : "| delete | [serviceUrl] | with | [body] | ",
"contexthelp" : "delete <serviceUrl> with <body>",
"name" : "deleteWith",
"docString" : "Sends HTTP DELETE body to service endpoint.\n@param body content to delete\n@param serviceUrl service endpoint to send body to.\n@return true if call could be made and response did not indicate error.",
"annotations" : [ ],
"parameters" : [ {
"name" : "serviceUrl",
"description" : "service endpoint to send body to.",
"type" : "String"
}, {
"name" : "body",
"description" : "content to delete",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "post file to",
"usage" : "| post file | [fileName] | to | [serviceUrl] | ",
"contexthelp" : "post file <fileName> to <serviceUrl>",
"name" : "postFileTo",
"docString" : "Sends a file by HTTP POST body to service endpoint.\n@param fileName fileName to post\n@param serviceUrl service endpoint to send body to.\n@return true if call could be made and response did not indicate error.",
"annotations" : [ ],
"parameters" : [ {
"name" : "fileName",
"description" : "fileName to post",
"type" : "String"
}, {
"name" : "serviceUrl",
"description" : "service endpoint to send body to.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "post file as to",
"usage" : "| post file | [fileName] | as | [partName] | to | [serviceUrl] | ",
"contexthelp" : "post file <fileName> as <partName> to <serviceUrl>",
"name" : "postFileAsTo",
"docString" : "Sends a file by HTTP POST body to service endpoint with specific partname.\n@param fileName fileName to post\n@param partName partName for file\n@param serviceUrl service endpoint to send body to.\n@return true if call could be made and response did not indicate error.",
"annotations" : [ ],
"parameters" : [ {
"name" : "fileName",
"description" : "fileName to post",
"type" : "String"
}, {
"name" : "partName",
"description" : "partName for file",
"type" : "String"
}, {
"name" : "serviceUrl",
"description" : "service endpoint to send body to.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "post values to",
"usage" : "| post values to | [serviceUrl] | ",
"contexthelp" : "post values to <serviceUrl>",
"name" : "postValuesTo",
"docString" : "Sends all values (url encoded) using post.\n@param serviceUrl service endpoint to send values to.\n@return true if call could be made and response did not indicate error.",
"annotations" : [ ],
"parameters" : [ {
"name" : "serviceUrl",
"description" : "service endpoint to send values to.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "put template to",
"usage" : "| put template to | [serviceUrl] | ",
"contexthelp" : "put template to <serviceUrl>",
"name" : "putTemplateTo",
"docString" : "Sends HTTP PUT template with current values to service endpoint.\n@param serviceUrl service endpoint to send request to.\n@return true if call could be made and response did not indicate error.",
"annotations" : [ ],
"parameters" : [ {
"name" : "serviceUrl",
"description" : "service endpoint to send request to.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "delete with template",
"usage" : "| delete with template | [serviceUrl] | ",
"contexthelp" : "delete with template <serviceUrl>",
"name" : "deleteWithTemplate",
"docString" : "Sends HTTP DELETE template with current values to service endpoint.\n@param serviceUrl service endpoint to send request to.\n@return true if call could be made and response did not indicate error.",
"annotations" : [ ],
"parameters" : [ {
"name" : "serviceUrl",
"description" : "service endpoint to send request to.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "patch with template",
"usage" : "| patch with template | [serviceUrl] | ",
"contexthelp" : "patch with template <serviceUrl>",
"name" : "patchWithTemplate",
"docString" : "Sends HTTP PATCH template with current values to service endpoint.\n@param serviceUrl service endpoint to send request to.\n@return true if call could be made and response did not indicate error.",
"annotations" : [ ],
"parameters" : [ {
"name" : "serviceUrl",
"description" : "service endpoint to send request to.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "send template to",
"usage" : "| send | [serviceUrl] | template | [aContentType] | to | [method] | ",
"contexthelp" : "send <serviceUrl> template <aContentType> to <method>",
"name" : "sendTemplateTo",
"docString" : "Sends HTTP method call template with current values to service endpoint.\n@param serviceUrl service endpoint to send request to.\n@param aContentType content type to use for post.\n@param method HTTP method to use\n@return true if call could be made and response did not indicate error.",
"annotations" : [ ],
"parameters" : [ {
"name" : "serviceUrl",
"description" : "service endpoint to send request to.",
"type" : "String"
}, {
"name" : "aContentType",
"description" : "content type to use for post.",
"type" : "String"
}, {
"name" : "method",
"description" : "HTTP method to use",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "put to",
"usage" : "| put | [body] | to | [serviceUrl] | ",
"contexthelp" : "put <body> to <serviceUrl>",
"name" : "putTo",
"docString" : "Sends HTTP PUT body to service endpoint.\n@param body content to put\n@param serviceUrl service endpoint to send body to.\n@return true if call could be made and response did not indicate error.",
"annotations" : [ ],
"parameters" : [ {
"name" : "body",
"description" : "content to put",
"type" : "String"
}, {
"name" : "serviceUrl",
"description" : "service endpoint to send body to.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "patch with",
"usage" : "| patch | [serviceUrl] | with | [body] | ",
"contexthelp" : "patch <serviceUrl> with <body>",
"name" : "patchWith",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "serviceUrl",
"type" : "String"
}, {
"name" : "body",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "put values to",
"usage" : "| put values to | [serviceUrl] | ",
"contexthelp" : "put values to <serviceUrl>",
"name" : "putValuesTo",
"docString" : "Sends all values (url encoded) using put.\n@param serviceUrl service endpoint to send values to.\n@return true if call could be made and response did not indicate error.",
"annotations" : [ ],
"parameters" : [ {
"name" : "serviceUrl",
"description" : "service endpoint to send values to.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "put file to",
"usage" : "| put file | [fileName] | to | [serviceUrl] | ",
"contexthelp" : "put file <fileName> to <serviceUrl>",
"name" : "putFileTo",
"docString" : "Sends a file by HTTP PUT body to service endpoint.\n@param fileName fileName to post\n@param serviceUrl service endpoint to send body to.\n@return true if call could be made and response did not indicate error.",
"annotations" : [ ],
"parameters" : [ {
"name" : "fileName",
"description" : "fileName to post",
"type" : "String"
}, {
"name" : "serviceUrl",
"description" : "service endpoint to send body to.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "put file as to",
"usage" : "| put file | [fileName] | as | [partName] | to | [serviceUrl] | ",
"contexthelp" : "put file <fileName> as <partName> to <serviceUrl>",
"name" : "putFileAsTo",
"docString" : "Sends a file by HTTP PUT body to service endpoint.\n@param fileName fileName to post\n@param partName partName for file\n@param serviceUrl service endpoint to send body to.\n@return true if call could be made and response did not indicate error.",
"annotations" : [ ],
"parameters" : [ {
"name" : "fileName",
"description" : "fileName to post",
"type" : "String"
}, {
"name" : "partName",
"description" : "partName for file",
"type" : "String"
}, {
"name" : "serviceUrl",
"description" : "service endpoint to send body to.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "get from",
"usage" : "| get from | [serviceUrl] | ",
"contexthelp" : "get from <serviceUrl>",
"name" : "getFrom",
"docString" : "Sends HTTP GET to service endpoint to retrieve content.\n@param serviceUrl service endpoint to get content from.\n@return true if call could be made and response did not indicate error.",
"annotations" : [ ],
"parameters" : [ {
"name" : "serviceUrl",
"description" : "service endpoint to get content from.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "get from no redirect",
"usage" : "| get from no redirect | [serviceUrl] | ",
"contexthelp" : "get from no redirect <serviceUrl>",
"name" : "getFromNoRedirect",
"docString" : "Sends HTTP GET to service endpoint to retrieve content, not following a redirect if sent.\n@param serviceUrl service endpoint to get content from.\n@return true if call could be made and response did not indicate error.",
"annotations" : [ ],
"parameters" : [ {
"name" : "serviceUrl",
"description" : "service endpoint to get content from.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "get file from",
"usage" : "| get file from | [serviceUrl] | ",
"contexthelp" : "get file from <serviceUrl>",
"name" : "getFileFrom",
"docString" : "Downloads binary content from specified url.\n@param serviceUrl url to download from\n@return link to downloaded file",
"annotations" : [ ],
"parameters" : [ {
"name" : "serviceUrl",
"description" : "url to download from",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "post values and get file from",
"usage" : "| post values and get file from | [serviceUrl] | ",
"contexthelp" : "post values and get file from <serviceUrl>",
"name" : "postValuesAndGetFileFrom",
"docString" : "Downloads binary content from specified url.\n@param serviceUrl url to download from\n@return link to downloaded file",
"annotations" : [ ],
"parameters" : [ {
"name" : "serviceUrl",
"description" : "url to download from",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "head from",
"usage" : "| head from | [serviceUrl] | ",
"contexthelp" : "head from <serviceUrl>",
"name" : "headFrom",
"docString" : "Sends HTTP HEAD to service endpoint.\n@param serviceUrl service endpoint to delete.\n@return true if call could be made and response did not indicate error.",
"annotations" : [ ],
"parameters" : [ {
"name" : "serviceUrl",
"description" : "service endpoint to delete.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "delete",
"usage" : "| delete | [serviceUrl] | ",
"contexthelp" : "delete <serviceUrl>",
"name" : "delete",
"docString" : "Sends HTTP DELETE to service endpoint.\n@param serviceUrl service endpoint to delete.\n@return true if call could be made and response did not indicate error.",
"annotations" : [ ],
"parameters" : [ {
"name" : "serviceUrl",
"description" : "service endpoint to delete.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "response is valid",
"usage" : "| response is valid |",
"contexthelp" : "response is valid",
"name" : "responseIsValid",
"docString" : "@return true if response does not indicate an error.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "request",
"usage" : "| request |",
"contexthelp" : "request",
"name" : "request",
"docString" : "@return request sent last time.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "request headers",
"usage" : "| request headers |",
"contexthelp" : "request headers",
"name" : "requestHeaders",
"docString" : "@return actual headers sent (these will contain the headers explicitly set and some implicit).",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "Map<Object>"
}, {
"readableName" : "response",
"usage" : "| response |",
"contexthelp" : "response",
"name" : "response",
"docString" : "@return response received last time postTo(), delete() or getFrom() was called.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "html response",
"usage" : "| html response |",
"contexthelp" : "html response",
"name" : "htmlResponse",
"docString" : "@return HTML response received last time postTo() or get() was called.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "response time",
"usage" : "| response time |",
"contexthelp" : "response time",
"name" : "responseTime",
"docString" : "@return response time in ms for call to service.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "long"
}, {
"readableName" : "response status",
"usage" : "| response status |",
"contexthelp" : "response status",
"name" : "responseStatus",
"docString" : "@return http status received in response to last request.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "response headers",
"usage" : "| response headers |",
"contexthelp" : "response headers",
"name" : "responseHeaders",
"docString" : "@return headers received with response to last request.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "Map<Object>"
}, {
"readableName" : "response header",
"usage" : "| response header | [headerName] | ",
"contexthelp" : "response header <headerName>",
"name" : "responseHeader",
"docString" : "@param headerName name of response header.\n@return value of header in last response (may be a list if the saame header name was sent multiple times\n (e.g. Set-Cookie).",
"annotations" : [ ],
"parameters" : [ {
"name" : "headerName",
"description" : "name of response header.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "Object"
}, {
"readableName" : "set store cookies",
"usage" : "| set store cookies | [storeCookies] | ",
"contexthelp" : "set store cookies <storeCookies>",
"name" : "setStoreCookies",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "storeCookies",
"type" : "boolean"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "copy browser cookies",
"usage" : "| copy browser cookies |",
"contexthelp" : "copy browser cookies",
"name" : "copyBrowserCookies",
"docString" : "Adds all current Selenium cookies to this fixture's cookie store.\n This will also ensure this class will store cookies (otherwise copying the cookies has no purpose).",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "cookie values",
"usage" : "| cookie values |",
"contexthelp" : "cookie values",
"name" : "cookieValues",
"docString" : "@return name->value of cookies in the cookie store.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "Map<String>"
}, {
"readableName" : "cookie value",
"usage" : "| cookie value | [cookieName] | ",
"contexthelp" : "cookie value <cookieName>",
"name" : "cookieValue",
"docString" : "@param cookieName name of cookie.\n@return value of cookie in the cookie store.",
"annotations" : [ ],
"parameters" : [ {
"name" : "cookieName",
"description" : "name of cookie.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "cookie domain",
"usage" : "| cookie domain | [cookieName] | ",
"contexthelp" : "cookie domain <cookieName>",
"name" : "cookieDomain",
"docString" : "@param cookieName name of cookie.\n@return domain of cookie in the cookie store.",
"annotations" : [ ],
"parameters" : [ {
"name" : "cookieName",
"description" : "name of cookie.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "cookie path",
"usage" : "| cookie path | [cookieName] | ",
"contexthelp" : "cookie path <cookieName>",
"name" : "cookiePath",
"docString" : "@param cookieName name of cookie.\n@return path of cookie in the cookie store.",
"annotations" : [ ],
"parameters" : [ {
"name" : "cookieName",
"description" : "name of cookie.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "cookie is persistent",
"usage" : "| cookie is persistent | [cookieName] | ",
"contexthelp" : "cookie is persistent <cookieName>",
"name" : "cookieIsPersistent",
"docString" : "@param cookieName name of cookie.\n@return whether cookie in the cookie store is persistent.",
"annotations" : [ ],
"parameters" : [ {
"name" : "cookieName",
"description" : "name of cookie.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "Boolean"
}, {
"readableName" : "cookie is secure",
"usage" : "| cookie is secure | [cookieName] | ",
"contexthelp" : "cookie is secure <cookieName>",
"name" : "cookieIsSecure",
"docString" : "@param cookieName name of cookie.\n@return whether cookie in the cookie store requires a secure connection.",
"annotations" : [ ],
"parameters" : [ {
"name" : "cookieName",
"description" : "name of cookie.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "Boolean"
}, {
"readableName" : "cookie is http only",
"usage" : "| cookie is http only | [cookieName] | ",
"contexthelp" : "cookie is http only <cookieName>",
"name" : "cookieIsHttpOnly",
"docString" : "@param cookieName name of cookie.\n@return whether cookie in the cookie store is http-only (not accessible to Javascript).",
"annotations" : [ ],
"parameters" : [ {
"name" : "cookieName",
"description" : "name of cookie.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "Boolean"
}, {
"readableName" : "cookie attribute",
"usage" : "| cookie | [cookieName] | attribute | [attributeName] | ",
"contexthelp" : "cookie <cookieName> attribute <attributeName>",
"name" : "cookieAttribute",
"docString" : "@param cookieName name of cookie.\n@param attributeName name of attribute.\n@return value of attribute for cookie.",
"annotations" : [ ],
"parameters" : [ {
"name" : "cookieName",
"description" : "name of cookie.",
"type" : "String"
}, {
"name" : "attributeName",
"description" : "name of attribute.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "clear cookies",
"usage" : "| clear cookies |",
"contexthelp" : "clear cookies",
"name" : "clearCookies",
"docString" : "Removes all cookies from the cookie store.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "get content type",
"usage" : "| get content type |",
"contexthelp" : "get content type",
"name" : "getContentType",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "set content type",
"usage" : "| set content type | [aContentType] | ",
"contexthelp" : "set content type <aContentType>",
"name" : "setContentType",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "aContentType",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set basic authorization header for user and password",
"usage" : "| set basic authorization header for user and | [user] | password | [password] | ",
"contexthelp" : "set basic authorization header for user and <user> password <password>",
"name" : "setBasicAuthorizationHeaderForUserAndPassword",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "user",
"type" : "String"
}, {
"name" : "password",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "is explicit content type set",
"usage" : "| is explicit content type set |",
"contexthelp" : "is explicit content type set",
"name" : "isExplicitContentTypeSet",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "set stop test on exception",
"usage" : "| set stop test on exception | [stopTestOnException] | ",
"contexthelp" : "set stop test on exception <stopTestOnException>",
"name" : "setStopTestOnException",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "stopTestOnException",
"type" : "boolean"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "stop test on exception",
"usage" : "| stop test on exception |",
"contexthelp" : "stop test on exception",
"name" : "stopTestOnException",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "repeat until response status is",
"usage" : "| repeat until response status is | [expectedStatus] | ",
"contexthelp" : "repeat until response status is <expectedStatus>",
"name" : "repeatUntilResponseStatusIs",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "expectedStatus",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "repeat until response is",
"usage" : "| repeat until response is | [expectedResponse] | ",
"contexthelp" : "repeat until response is <expectedResponse>",
"name" : "repeatUntilResponseIs",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "expectedResponse",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "repeat until response is not",
"usage" : "| repeat until response is not | [expectedResponse] | ",
"contexthelp" : "repeat until response is not <expectedResponse>",
"name" : "repeatUntilResponseIsNot",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "expectedResponse",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "repeat until header is",
"usage" : "| repeat until header | [header] | is | [expectedValue] | ",
"contexthelp" : "repeat until header <header> is <expectedValue>",
"name" : "repeatUntilHeaderIs",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "header",
"type" : "String"
}, {
"name" : "expectedValue",
"type" : "Object"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "set int value for",
"usage" : "| set int value | [value] | for | [name] | ",
"contexthelp" : "set int value <value> for <name>",
"name" : "setIntValueFor",
"docString" : "Stores integer value.\n@param value value to be passed.\n@param name name to use this value for.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to be passed.",
"type" : "int"
}, {
"name" : "name",
"description" : "name to use this value for.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set double value for",
"usage" : "| set double value | [value] | for | [name] | ",
"contexthelp" : "set double value <value> for <name>",
"name" : "setDoubleValueFor",
"docString" : "Stores double value.\n@param value value to be passed.\n@param name name to use this value for.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to be passed.",
"type" : "double"
}, {
"name" : "name",
"description" : "name to use this value for.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set boolean value for",
"usage" : "| set boolean value | [value] | for | [name] | ",
"contexthelp" : "set boolean value <value> for <name>",
"name" : "setBooleanValueFor",
"docString" : "Stores boolean value.\n@param value value to be passed.\n@param name name to use this value for.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to be passed.",
"type" : "boolean"
}, {
"name" : "name",
"description" : "name to use this value for.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set value for",
"usage" : "| set value | [value] | for | [name] | ",
"contexthelp" : "set value <value> for <name>",
"name" : "setValueFor",
"docString" : "Stores value.\n@param value value to be stored.\n@param name name to use this value for.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to be stored.",
"type" : "Object"
}, {
"name" : "name",
"description" : "name to use this value for.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "add value to",
"usage" : "| add value | [value] | to | [name] | ",
"contexthelp" : "add value <value> to <name>",
"name" : "addValueTo",
"docString" : "Adds value to (end of) a list.\n@param value value to be stored.\n@param name name of list to extend.",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"description" : "value to be stored.",
"type" : "Object"
}, {
"name" : "name",
"description" : "name of list to extend.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "copy values from",
"usage" : "| copy values from | [map] | ",
"contexthelp" : "copy values from <map>",
"name" : "copyValuesFrom",
"docString" : "Adds all values in the supplied map to the current values.\n@param map to obtain values from.",
"annotations" : [ ],
"parameters" : [ {
"name" : "map",
"description" : "to obtain values from.",
"type" : "Map<Object>"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set values for",
"usage" : "| set values | [values] | for | [name] | ",
"contexthelp" : "set values <values> for <name>",
"name" : "setValuesFor",
"docString" : "Stores list of values in map.\n@param values comma separated list of values.\n@param name name to use this list for.",
"annotations" : [ ],
"parameters" : [ {
"name" : "values",
"description" : "comma separated list of values.",
"type" : "String"
}, {
"name" : "name",
"description" : "name to use this list for.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set content of as value for",
"usage" : "| set content of as value | [file] | for | [key] | ",
"contexthelp" : "set content of as value <file> for <key>",
"name" : "setContentOfAsValueFor",
"docString" : "@param file file's whose content should be set as byte[]\n@param key key whose value should be set.",
"annotations" : [ ],
"parameters" : [ {
"name" : "file",
"description" : "file's whose content should be set as byte[]",
"type" : "String"
}, {
"name" : "key",
"description" : "key whose value should be set.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set base 64 encoded content of as value for",
"usage" : "| set base 64 encoded content of as value | [file] | for | [key] | ",
"contexthelp" : "set base 64 encoded content of as value <file> for <key>",
"name" : "setBase64EncodedContentOfAsValueFor",
"docString" : "@param file file's whose content should be base64 encoded\n@param key key whose value should be set.",
"annotations" : [ ],
"parameters" : [ {
"name" : "file",
"description" : "file's whose content should be base64 encoded",
"type" : "String"
}, {
"name" : "key",
"description" : "key whose value should be set.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "clear value",
"usage" : "| clear value | [name] | ",
"contexthelp" : "clear value <name>",
"name" : "clearValue",
"docString" : "Clears a values previously set.\n@param name value to remove.\n@return true if value was present.",
"annotations" : [ ],
"parameters" : [ {
"name" : "name",
"description" : "value to remove.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "clear values",
"usage" : "| clear values |",
"contexthelp" : "clear values",
"name" : "clearValues",
"docString" : "Clears all values previously set.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "value",
"usage" : "| value | [name] | ",
"contexthelp" : "value <name>",
"name" : "value",
"docString" : "Retrieves value of element at a specified key.\n@param name key to get value of (nested values may be retrieved by separating the keys with '.').\n@return value stored.",
"annotations" : [ ],
"parameters" : [ {
"name" : "name",
"description" : "key to get value of (nested values may be retrieved by separating the keys with '.').",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "Object"
}, {
"readableName" : "reset",
"usage" : "| reset |",
"contexthelp" : "reset",
"name" : "reset",
"docString" : "Called before next row is executed. (Clears all current values.)",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set",
"usage" : "| set | key, value, |",
"contexthelp" : "set key, value,",
"name" : "set",
"docString" : "Sets a value.\n@param key (possibly nested) key to set value for.\n@param value value to be stored.",
"annotations" : [ ],
"parameters" : [ {
"name" : "key",
"description" : "(possibly nested) key to set value for.",
"type" : "String"
}, {
"name" : "value",
"description" : "value to be stored.",
"type" : "Object"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "expand periods in names to nested maps",
"usage" : "| expand periods in names to nested maps | [expand] | ",
"contexthelp" : "expand periods in names to nested maps <expand>",
"name" : "expandPeriodsInNamesToNestedMaps",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "expand",
"type" : "boolean"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "expands periods in names to nested maps",
"usage" : "| expands periods in names to nested maps |",
"contexthelp" : "expands periods in names to nested maps",
"name" : "expandsPeriodsInNamesToNestedMaps",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "get map helper",
"usage" : "| get map helper |",
"contexthelp" : "get map helper",
"name" : "getMapHelper",
"docString" : "@return helper to assist getting/setting (nested) values in a map.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "MapHelper"
}, {
"readableName" : "set map helper",
"usage" : "| set map helper | [mapHelper] | ",
"contexthelp" : "set map helper <mapHelper>",
"name" : "setMapHelper",
"docString" : "@param mapHelper helper to assist getting/setting (nested) values in a map.",
"annotations" : [ ],
"parameters" : [ {
"name" : "mapHelper",
"description" : "helper to assist getting/setting (nested) values in a map.",
"type" : "MapHelper"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set global value to",
"usage" : "| set global value | [symbolName] | to | [value] | ",
"contexthelp" : "set global value <symbolName> to <value>",
"name" : "setGlobalValueTo",
"docString" : "Stores a (global) value so it can be accessed by other fixtures/pages.\n@param symbolName name to store value under.\n@param value value to store.",
"annotations" : [ ],
"parameters" : [ {
"name" : "symbolName",
"description" : "name to store value under.",
"type" : "String"
}, {
"name" : "value",
"description" : "value to store.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "global value",
"usage" : "| global value | [symbolName] | ",
"contexthelp" : "global value <symbolName>",
"name" : "globalValue",
"docString" : "Retrieves a (global) value, which was previously stored using #setGlobalValueTo().\n@param symbolName name value was stored under.",
"annotations" : [ ],
"parameters" : [ {
"name" : "symbolName",
"description" : "name value was stored under.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "wait seconds",
"usage" : "| wait seconds | [i] | ",
"contexthelp" : "wait seconds <i>",
"name" : "waitSeconds",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "i",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "wait milliseconds",
"usage" : "| wait milliseconds | [i] | ",
"contexthelp" : "wait milliseconds <i>",
"name" : "waitMilliseconds",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "i",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "set repeat interval to milliseconds",
"usage" : "| set repeat interval to milliseconds | [milliseconds] | ",
"contexthelp" : "set repeat interval to milliseconds <milliseconds>",
"name" : "setRepeatIntervalToMilliseconds",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "milliseconds",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "repeat interval",
"usage" : "| repeat interval |",
"contexthelp" : "repeat interval",
"name" : "repeatInterval",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "long"
}, {
"readableName" : "repeat at most times",
"usage" : "| repeat at most times | [maxCount] | ",
"contexthelp" : "repeat at most times <maxCount>",
"name" : "repeatAtMostTimes",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "maxCount",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "repeat at most times",
"usage" : "| repeat at most times |",
"contexthelp" : "repeat at most times",
"name" : "repeatAtMostTimes",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "repeat count",
"usage" : "| repeat count |",
"contexthelp" : "repeat count",
"name" : "repeatCount",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "time spent repeating",
"usage" : "| time spent repeating |",
"contexthelp" : "time spent repeating",
"name" : "timeSpentRepeating",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "long"
} ],
"typeName" : "nl.hsac.fitnesse.fixture.slim.JsonHttpTest",
"name" : "JsonHttpTest",
"annotations" : [ ]
}© 2015 - 2024 Weber Informatics LLC | Privacy Policy