META-INF.apidocs.nl.hsac.fitnesse.fixture.slim.HttpClientSetup.json Maven / Gradle / Ivy
{
"constructors": [
{
"readableName": "http client setup",
"usage": "| http client setup |",
"name": "HttpClientSetup",
"docString": "",
"annotations": [],
"parameters": [],
"exceptions": []
},
{
"readableName": "http client setup",
"usage": "| http client setup | [clientFactory] |",
"name": "HttpClientSetup",
"docString": "",
"annotations": [],
"parameters": [
{
"name": "clientFactory",
"type": "HttpClientFactory"
}
],
"exceptions": []
}
],
"qualifiedName": "nl.hsac.fitnesse.fixture.slim.HttpClientSetup",
"publicMethods": [
{
"readableName": "configure http test",
"usage": "| configure http test |",
"contexthelp": "configure http test",
"name": "configureHttpTest",
"docString": "Configure future http test usage to use the current settings.",
"annotations": [],
"returnDescription": "true",
"parameters": [],
"exceptions": [],
"returnType": "boolean"
},
{
"readableName": "create client",
"usage": "| create client |",
"contexthelp": "create client",
"name": "createClient",
"docString": "Creates a client using the current settings.",
"annotations": [],
"returnDescription": "apache http client.",
"parameters": [],
"exceptions": [],
"returnType": "HttpClient"
},
{
"readableName": "configure http test with",
"usage": "| configure http test with | [client] | ",
"contexthelp": "configure http test with \u0026lt;client\u0026gt;",
"name": "configureHttpTestWith",
"docString": "Configure future http test usage to use the client supplied.",
"annotations": [],
"returnDescription": "true",
"parameters": [
{
"name": "client",
"description": "client to use.",
"type": "HttpClient"
}
],
"exceptions": [],
"returnType": "boolean"
},
{
"readableName": "enable content compression",
"usage": "| enable content compression |",
"contexthelp": "enable content compression",
"name": "enableContentCompression",
"docString": "Enables content compression support (i.e. gzip) for all subsequent requests until the end of the test run.",
"annotations": [],
"parameters": [],
"exceptions": [],
"returnType": "void"
},
{
"readableName": "disable ssl verification",
"usage": "| disable ssl verification |",
"contexthelp": "disable ssl verification",
"name": "disableSSLVerification",
"docString": "Disables SSL certificate verification for all subsequent requests until the end of the test run.\n Use at your own risk! This makes https potentially as unsafe as http!",
"annotations": [],
"parameters": [],
"exceptions": [],
"returnType": "void"
},
{
"readableName": "enable ssl verification",
"usage": "| enable ssl verification |",
"contexthelp": "enable ssl verification",
"name": "enableSSLVerification",
"docString": "Enables SSL certificate verification for all subsequent requests until the end of the test run.",
"annotations": [],
"parameters": [],
"exceptions": [],
"returnType": "void"
},
{
"readableName": "set proxy",
"usage": "| set proxy | [proxyUrl] | ",
"contexthelp": "set proxy \u0026lt;proxyUrl\u0026gt;",
"name": "setProxy",
"docString": "Sets proxy server to use. Proxy URL should contain a host name and may contain a port\n (separated by \u0027:\u0027). A scheme (http or https) is only required if the proxy should only be used for\n that scheme.",
"annotations": [],
"parameters": [
{
"name": "proxyUrl",
"description": "proxy server to use (e.g. proxy.mydomain.com:8080)",
"type": "String"
}
],
"exceptions": [],
"returnType": "void"
},
{
"readableName": "set proxy username and password",
"usage": "| set proxy username and | [username] | password | [password] | ",
"contexthelp": "set proxy username and \u0026lt;username\u0026gt; password \u0026lt;password\u0026gt;",
"name": "setProxyUsernameAndPassword",
"docString": "Sets credentials to supply to proxy.",
"annotations": [],
"parameters": [
{
"name": "username",
"description": "username to send to proxy server",
"type": "String"
},
{
"name": "password",
"description": "password to send to proxy server",
"type": "String"
}
],
"exceptions": [],
"returnType": "void"
},
{
"readableName": "set trust store with password",
"usage": "| set trust store with | [trustStore] | password | [password] | ",
"contexthelp": "set trust store with \u0026lt;trustStore\u0026gt; password \u0026lt;password\u0026gt;",
"name": "setTrustStoreWithPassword",
"docString": "Use SSL trust store (i.e. .jks).",
"annotations": [],
"parameters": [
{
"name": "trustStore",
"description": ".jks file to use",
"type": "String"
},
{
"name": "password",
"description": "password to open .jks",
"type": "String"
}
],
"exceptions": [],
"returnType": "void"
},
{
"readableName": "set client certificate from with password key password",
"usage": "| set client certificate from with password | [keyStore] | key | [keyStorePassword] | password | [keyPassword] | ",
"contexthelp": "set client certificate from with password \u0026lt;keyStore\u0026gt; key \u0026lt;keyStorePassword\u0026gt; password \u0026lt;keyPassword\u0026gt;",
"name": "setClientCertificateFromWithPasswordKeyPassword",
"docString": "Send client certificate.",
"annotations": [],
"parameters": [
{
"name": "keyStore",
"description": ".jks file to use",
"type": "String"
},
{
"name": "keyStorePassword",
"description": "password to open .jks",
"type": "String"
},
{
"name": "keyPassword",
"description": "password for client certificate in .jks",
"type": "String"
}
],
"exceptions": [],
"returnType": "void"
},
{
"readableName": "set client certificate from with password key password and alias",
"usage": "| set client certificate from with password key | [keyStore] | password | [keyStorePassword] | and | [keyPassword] | alias | [alias] | ",
"contexthelp": "set client certificate from with password key \u0026lt;keyStore\u0026gt; password \u0026lt;keyStorePassword\u0026gt; and \u0026lt;keyPassword\u0026gt; alias \u0026lt;alias\u0026gt;",
"name": "setClientCertificateFromWithPasswordKeyPasswordAndAlias",
"docString": "Send client certificate.",
"annotations": [],
"parameters": [
{
"name": "keyStore",
"description": ".jks file to use",
"type": "String"
},
{
"name": "keyStorePassword",
"description": "password to open .jks",
"type": "String"
},
{
"name": "keyPassword",
"description": "password for client certificate in .jks",
"type": "String"
},
{
"name": "alias",
"description": "alias to choose client certificate",
"type": "String"
}
],
"exceptions": [],
"returnType": "void"
},
{
"readableName": "configure request username and password",
"usage": "| configure request username | [username] | and password | [password] |",
"contexthelp": "configure request username \u0026lt;username\u0026gt; and password \u0026lt;password\u0026gt;",
"name": "configureRequestUsernameAndPassword",
"docString": "Configure Basic User/Pass authentication for all requests.\n Usage: | configure request username | [username] | and password | [password] |",
"annotations": [],
"parameters": [
{
"name": "username",
"description": "The user to authenticate with",
"type": "String"
},
{
"name": "password",
"description": "The password to use",
"type": "String"
}
],
"exceptions": [],
"returnType": "void"
},
{
"readableName": "use windows authentication",
"usage": "| use windows authentication | [useWinAuth] | ",
"contexthelp": "use windows authentication \u0026lt;useWinAuth\u0026gt;",
"name": "useWindowsAuthentication",
"docString": "Use Currently logged in Windows user authentication on requests if running on windows and the credential can be obtained through JNI",
"annotations": [],
"parameters": [
{
"name": "useWinAuth",
"description": "if true, windows authentication will be attempted",
"type": "boolean"
}
],
"exceptions": [],
"returnType": "void"
},
{
"readableName": "connection timeout milliseconds",
"usage": "| connection timeout milliseconds | [connectionTimeout] | ",
"contexthelp": "connection timeout milliseconds \u0026lt;connectionTimeout\u0026gt;",
"name": "connectionTimeoutMilliseconds",
"docString": "Determines the timeout in milliseconds until a connection is established.\n\n A timeout value of zero is interpreted as an infinite timeout.\n A negative value is interpreted as undefined (system default if applicable).",
"annotations": [],
"parameters": [
{
"name": "connectionTimeout",
"description": "timeout in milliseconds",
"type": "int"
}
],
"exceptions": [],
"returnType": "void"
},
{
"readableName": "socket timeout milliseconds",
"usage": "| socket timeout milliseconds | [socketTimeout] | ",
"contexthelp": "socket timeout milliseconds \u0026lt;socketTimeout\u0026gt;",
"name": "socketTimeoutMilliseconds",
"docString": "Defines the socket timeout in milliseconds,\n which is the timeout for waiting for data or, put differently,\n a maximum period inactivity between two consecutive data packets.\n\n A timeout value of zero is interpreted as an infinite timeout.\n A negative value is interpreted as undefined (system default if applicable).",
"annotations": [],
"parameters": [
{
"name": "socketTimeout",
"description": "timeout in milliseconds",
"type": "int"
}
],
"exceptions": [],
"returnType": "void"
},
{
"readableName": "get original client",
"usage": "| get original client |",
"contexthelp": "get original client",
"name": "getOriginalClient",
"docString": "",
"annotations": [],
"returnDescription": "the http client at the moment this http client setup instance was created,\n so it may be stored in a Slim symbol to be restored later.",
"parameters": [],
"exceptions": [],
"returnType": "HttpClient"
},
{
"readableName": "get client factory",
"usage": "| get client factory |",
"contexthelp": "get client factory",
"name": "getClientFactory",
"docString": "",
"annotations": [],
"returnDescription": "factory to actually create Apache HttpClient instances",
"parameters": [],
"exceptions": [],
"returnType": "HttpClientFactory"
},
{
"readableName": "set global value to",
"usage": "| set global value | [symbolName] | to | [value] | ",
"contexthelp": "set global value \u0026lt;symbolName\u0026gt; to \u0026lt;value\u0026gt;",
"name": "setGlobalValueTo",
"docString": "Stores a (global) value so it can be accessed by other fixtures/pages.",
"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 \u0026lt;symbolName\u0026gt;",
"name": "globalValue",
"docString": "Retrieves a (global) value, which was previously stored using #setGlobalValueTo().",
"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 \u0026lt;i\u0026gt;",
"name": "waitSeconds",
"docString": "",
"annotations": [],
"parameters": [
{
"name": "i",
"type": "int"
}
],
"exceptions": [],
"returnType": "boolean"
},
{
"readableName": "wait milliseconds",
"usage": "| wait milliseconds | [i] | ",
"contexthelp": "wait milliseconds \u0026lt;i\u0026gt;",
"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 \u0026lt;milliseconds\u0026gt;",
"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 \u0026lt;maxCount\u0026gt;",
"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": "HttpClientSetup",
"name": "HttpClientSetup",
"annotations": []
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy