Package org.apache.camel.model.rest
Class RestSecurityApiKey
- java.lang.Object
-
- org.apache.camel.model.rest.RestSecurityDefinition
-
- org.apache.camel.model.rest.RestSecurityApiKey
-
@Metadata(label="rest,security,configuration") public class RestSecurityApiKey extends RestSecurityDefinition
Rest security basic auth definition
-
-
Constructor Summary
Constructors Constructor Description RestSecurityApiKey()
RestSecurityApiKey(RestDefinition rest)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RestSecuritiesDefinition
end()
String
getInCookie()
String
getInHeader()
String
getInQuery()
String
getName()
void
setInCookie(String inCookie)
To use a cookie as the location of the API key.void
setInHeader(String inHeader)
To use header as the location of the API key.void
setInQuery(String inQuery)
To use query parameter as the location of the API key.void
setName(String name)
The name of the header or query parameter to be used.RestSecurityApiKey
withCookie(String name)
RestSecurityApiKey
withHeader(String name)
RestSecurityApiKey
withQuery(String name)
-
Methods inherited from class org.apache.camel.model.rest.RestSecurityDefinition
endSecurityDefinition, getDescription, getKey, setDescription, setKey
-
-
-
-
Constructor Detail
-
RestSecurityApiKey
public RestSecurityApiKey()
-
RestSecurityApiKey
public RestSecurityApiKey(RestDefinition rest)
-
-
Method Detail
-
getName
public String getName()
-
setName
public void setName(String name)
The name of the header or query parameter to be used.
-
getInHeader
public String getInHeader()
-
setInHeader
public void setInHeader(String inHeader)
To use header as the location of the API key.
-
getInQuery
public String getInQuery()
-
setInQuery
public void setInQuery(String inQuery)
To use query parameter as the location of the API key.
-
getInCookie
public String getInCookie()
-
setInCookie
public void setInCookie(String inCookie)
To use a cookie as the location of the API key.
-
withHeader
public RestSecurityApiKey withHeader(String name)
-
withQuery
public RestSecurityApiKey withQuery(String name)
-
withCookie
public RestSecurityApiKey withCookie(String name)
-
end
public RestSecuritiesDefinition end()
-
-