|
Generated by JDiff |
||||||||
| PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES | |||||||||
This file contains all the changes in documentation in the packageorg.springframework.web.utilas colored differences. Deletions are shownlike this, and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently.
Use the given domain for cookies created by this generator. The cookie is only visible to servers in this domain. @see javax.servlet.http.Cookie#setDomainClass CookieGenerator, void setCookieMaxAge(Integer)
Use the given maximum age (in seconds) for cookies created by this generator. Useful special value: -1 ... not persistent, deleted when client shutsClass CookieGenerator, void setCookieName(String)downdown @see javax.servlet.http.Cookie#setMaxAge
Use the given name for cookies created by this generator. @see javax.servlet.http.Cookie#getName()Class CookieGenerator, void setCookiePath(String)
Use the given path for cookies created by this generator. The cookie is only visible to URLs in this path and below. @see javax.servlet.http.Cookie#setPathClass CookieGenerator, void setCookieSecure(boolean)
Set whether the cookie should only be sent using a secure protocol, such as HTTPS (SSL). This is an indication to the receiving browser, not processed by the HTTP server itself. Default is "false". @see javax.servlet.http.Cookie#setSecure
Represents an immutable collection of URI components, mapping component type toClass UriComponents, UriComponents encode()stringstring values. Containsconvenienceconvenience getters for all components. Effectively similar to java.net.URI, but with more powerful encoding options andsupportsupport for URItemplatetemplate variables. @author Arjen Poutsma @since 3.1 @see UriComponentsBuilder
Class UriComponents, UriComponents encode(String)EncodesEncode all URI components using their specific encoding rules, and returns theresultresult as anewnew {@code UriComponents} instance. This method uses UTF-8 to encode.@return the encoded uri components
Class UriComponents, UriComponents expand(Map<String, ?>)EncodesEncode all URI components using their specific encoding rules,andand returns the result as anewnew {@code UriComponents} instance.@param encoding the encoding of the values contained in this map @return the encoded uri components @throws UnsupportedEncodingException if the given encoding is not supported
Replaces all URI template variables with the values from a given map. The mapClass UriComponents, UriComponents expand(Object[])keys representkeys represent variable names; the values variable values. The order of variables isnotnot significant.@param uriVariables the map of URI variables @return the expanded uri components
Replaces all URI template variables with the values from a given array. TheClass UriComponents, String getFragment()arrayarray represent variable values.The order of variables is significant.@param uriVariableValues URI variable values @return the expanded uri components
Returns the fragment.Class UriComponents, String getHost()@return the fragment.Can be {@code null}.
Returns the host.Class UriComponents, String getPath()@return the host.Can be {@code null}.
Returns the path.Class UriComponents, List<String> getPathSegments()@return the path.Can be {@code null}.
Returns the list of path segments.Class UriComponents, int getPort()@return the path segments.Empty if no path has been set.
Returns the port. Returns {@code -1} if no port has been set.Class UriComponents, String getQuery()@return the port
Returns the query.Class UriComponents, MultiValueMap<String, String> getQueryParams()@return the query.Can be {@code null}.
Returns the map of query parameters.Class UriComponents, String getScheme()@return the query parameters.Empty if no query has been set.
Returns the scheme.Class UriComponents, String getUserInfo()@return the scheme.Can be {@code null}.
Returns the user info.Class UriComponents, UriComponents normalize()@return the user info.Can be {@code null}.
Normalize the path removing sequences like "path/..". @see org.springframework.util.StringUtils#cleanPath(String)Class UriComponents, URI toUri()
Returns a {@code URI} from this {@code UriComponents} instance.Class UriComponents, String toUriString()@return the URI
Returns a URI string from this {@code UriComponents} instance.@return the URI string
Builder for UriComponents.Class UriComponentsBuilder, UriComponentsBuilder host(String)Typical usage involves:@author Arjen Poutsma @author Rossen Stoyanchev @since 3.1 @see #newInstance() @see #fromPath(String) @see #fromUri(URI)
- Create a {@code UriComponentsBuilder} with one of the static factory methods (such as .fromPath(String) or .fromUri(URI))
- Set the various URI components through the respective methods (.scheme(String), .userInfo(String), .host(String), .port(int), .path(String), .pathSegment(String...), .queryParam(String, Object...), and .fragment(String).
- Build the UriComponents instance with the .build() method.
@since 3.1
Sets the URI host. The given host may contain URI template variables, and may also be {@code null} to clear the host of this builder. @paramClass UriComponentsBuilder, UriComponentsBuilder path(String)hosthost the URI host @return this UriComponentsBuilder
Appends the given path to the existing path of this builder. The given path may contain URI template variables. @paramClass UriComponentsBuilder, UriComponentsBuilder userInfo(String)pathpath the URI path @return this UriComponentsBuilder
Sets the URI user info. The given user info may contain URI template variables, and may also be {@code null} to clear the user info of this builder. @paramuserInfouserInfothe URI user info @return this UriComponentsBuilder
Utility class for URI encoding and decoding based on RFC 3986. Offers encoding methods for the various URI components.Class UriUtils, String decode(String, String)All {@code encode*(String, String} methods in this class operate in a similar way:
@author Arjen Poutsma @since 3.0 @see RFC 3986
- Valid characters for the specific URI component as defined in RFC 3986 stay the same.
- All other characters are converted into one or more bytes in the given encoding scheme. Each of the
resulting bytes is written as a hexadecimal string in the "%xy" format.
Decodes the given encoded source String into an URI. Based on the following rules:Class UriUtils, String encodeHttpUrl(String, String)@param source the source string @param encoding the encoding @return the decoded URI @throws IllegalArgumentException when the given source contains invalid encoded sequences @throws UnsupportedEncodingException when the given encoding parameter is not supported @see java.net.URLDecoder#decode(String, String)
- Alphanumeric characters {@code "a"} through {@code "z"}, {@code "A"} through {@code "Z"}, and
{@code "0"} through {@code "9"} stay the same.- Special characters {@code "-"}, {@code "_"}, {@code "."}, and {@code "*"} stay the same.
- A sequence "
%xy" is interpreted as a hexadecimal representation of the character.
Encodes the given HTTP URI into an encoded String. All various URI components are encoded according to their respective valid character sets.Class UriUtils, String encodeUri(String, String)Note that this method does not support fragments ({@code #}), as these are not supposed to be sent to the server, but retained by the client.
Note that this method does not attempt to encode "=" and "&" characters in query parameter names and query parameter values because they cannot be parsed in a reliable way. Instead use:
@param httpUrl the HTTP URL to be encoded @param encoding the character encoding to encode to @return the encoded URL @throws IllegalArgumentException when the given uri parameter is not a valid URI @throws UnsupportedEncodingException when the given encoding parameter is not supported @deprecated in favor of UriComponentsBuilder; see note about query param encodingUriComponents uriComponents = UriComponentsBuilder.fromHttpUrl("/path?name={value}").buildAndExpand("a=b");String encodedUri = uriComponents.encode().toUriString();
Encodes the given source URI into an encoded String. All various URI components are encoded according to their respective valid character sets.Note that this method does not attempt to encode "=" and "&" characters in query parameter names and query parameter values because they cannot be parsed in a reliable way. Instead use:
@param uri the URI to be encoded @param encoding the character encoding to encode to @return the encoded URI @throws IllegalArgumentException when the given uri parameter is not a valid URI @throws UnsupportedEncodingException when the given encoding parameter is not supported @deprecated in favor of UriComponentsBuilder; see note about query param encodingUriComponents uriComponents = UriComponentsBuilder.fromUri("/path?name={value}").buildAndExpand("a=b");String encodedUri = uriComponents.encode().toUriString();