Package org.refcodes.net
Interface RequestHeaderFields
-
- All Superinterfaces:
BasicAuthCredentialsAccessor
,BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<RequestHeaderFields>
,BasicAuthCredentialsAccessor.BasicAuthCredentialsMutator
,BasicAuthCredentialsAccessor.BasicAuthCredentialsProperty
,BearerAuthCredentialsAccessor
,BearerAuthCredentialsAccessor.BearerAuthCredentialsBuilder<RequestHeaderFields>
,BearerAuthCredentialsAccessor.BearerAuthCredentialsMutator
,BearerAuthCredentialsAccessor.BearerAuthCredentialsProperty
,HeaderFields<RequestCookie,RequestHeaderFields>
,HttpFields<RequestHeaderFields>
,java.util.Map<java.lang.String,java.util.List<java.lang.String>>
- All Known Implementing Classes:
RequestHeaderFieldsImpl
public interface RequestHeaderFields extends HeaderFields<RequestCookie,RequestHeaderFields>
TheRequestHeaderFields
reflect the structure of a HTTP header and may be used to represent a HTTP header.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.refcodes.net.BasicAuthCredentialsAccessor
BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<B extends BasicAuthCredentialsAccessor.BasicAuthCredentialsBuilder<B>>, BasicAuthCredentialsAccessor.BasicAuthCredentialsMutator, BasicAuthCredentialsAccessor.BasicAuthCredentialsProperty
-
Nested classes/interfaces inherited from interface org.refcodes.net.BearerAuthCredentialsAccessor
BearerAuthCredentialsAccessor.BearerAuthCredentialsBuilder<B extends BearerAuthCredentialsAccessor.BearerAuthCredentialsBuilder<B>>, BearerAuthCredentialsAccessor.BearerAuthCredentialsMutator, BearerAuthCredentialsAccessor.BearerAuthCredentialsProperty
-
-
Field Summary
-
Fields inherited from interface org.refcodes.net.HeaderFields
BASIC_REALM
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default RequestCookie
addCookie(java.lang.String aHttpCookie)
Adds an individual server-side cookie to be sent to the client to thisResponseHeaderFields
instance.-
Methods inherited from interface org.refcodes.net.BasicAuthCredentialsAccessor.BasicAuthCredentialsMutator
putBasicAuthCredentials
-
Methods inherited from interface org.refcodes.net.BearerAuthCredentialsAccessor.BearerAuthCredentialsMutator
putBearerAuthCredentials
-
Methods inherited from interface org.refcodes.net.HeaderFields
addCookie, addCookie, addTo, addTo, addTo, get, getAcceptCharsets, getAcceptEncodings, getAcceptTypes, getAllCookies, getAllowMethods, getAuthenticate, getBasicAuth, getBasicAuthCredentials, getBearerAuthCredentials, getContentEncoding, getContentType, getCookies, getFirst, getFirstCookie, getHost, getRequestId, getSessionId, getUnknownAcceptTypes, getUnknownContentTypes, getUserAgent, put, put, put, putAcceptCharsets, putAcceptCharsets, putAcceptEncodings, putAcceptEncodings, putAcceptTypes, putAcceptTypes, putAllowMethods, putAllowMethods, putAuthenticate, putBasicAuthCredentials, putBasicAuthRequired, putBearerAuthCredentials, putContentEncoding, putContentType, putContentType, putHost, putRequestId, putSessionId, putUserAgent, remove, removeAcceptCharsets, removeAcceptEncodings, removeAcceptTypes, removeAllowMethods, removeAuthenticate, removeBasicAuthCredentials, removeBasicAuthenticate, removeBearerAuthCredentials, removeContentEncoding, removeContentType, removeHost, removeRequestId, removeSessionId, removeUserAgent, toBasicAuthRealm, toHeaderFields, toHttpCookies, withAcceptCharsets, withAcceptCharsets, withAcceptEncodings, withAcceptEncodings, withAcceptTypes, withAcceptTypes, withAddCookie, withAddCookie, withAddTo, withAddTo, withAddTo, withAllowMethods, withAllowMethods, withAuthenticate, withBasicAuthCredentials, withBasicAuthCredentials, withBasicAuthRequired, withBearerAuthCredentials, withBearerAuthCredentials, withContentEncoding, withContentType, withContentType, withHost, withPut, withPut, withPut, withRequestId, withSessionId, withUserAgent
-
-
-
-
Method Detail
-
addCookie
default RequestCookie addCookie(java.lang.String aHttpCookie)
Adds an individual server-side cookie to be sent to the client to thisResponseHeaderFields
instance. The server-side cookies are retrieved from theHeaderField.SET_COOKIE
Header-Field. WITH THE METHODHeaderFields.getAllCookies()
andHeaderFields.getCookies(String)
as well asHeaderFields.getFirstCookie(String)
ONLY THE COOKIES SENT BY THE CLIENT CAN BE RETRIEVED (E.G. COOKIES RESIDING IN THE HEADER FIELDHeaderField.COOKIE
). COOKIES SET VIAHeaderFields.addCookie(String, String)
ORHeaderFields.withAddCookie(String, String)
CANNOT BE RETRIEVED, AS THE COOKIES BEING SET SERVER-SIDE ARE PUT IN THEHeaderField.SET_COOKIE
Header-Field.- Specified by:
addCookie
in interfaceHeaderFields<RequestCookie,RequestHeaderFields>
- Parameters:
aHttpCookie
- The HTTP-CookieString
to be paresd as a cookie.- Returns:
- The resulting cookie builder being added which can be modified
affecting(!) this
ResponseHeaderFields
instance!
-
-