HttpAddress (SAP Cloud Platform - Server OData API for Mobile Services)

java.lang.Object
- com.sap.cloud.server.odata.http.HttpAddress

public class HttpAddress
extends java.lang.Object

Encapsulates a parsed HTTP URL.

See Also:: RFC 3986.

Constructor Summary

Constructors
Constructor and Description

HttpAddress()

Constructors
Constructor and Description
`HttpAddress()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getAbsolute()` Return true for absolute URL, `false` for relative URL.
`java.lang.String`	`getAuthority()` Return (nullable) Authority component, e.g.
`java.lang.String`	`getFragment()` Return (nullable) Optional fragment component, e.g.
`java.lang.String`	`getHost()` Return host subcomponent of `HttpAddress.authority`, e.g.
`java.lang.String`	`getPath()` Return (nullable) Optional path component, e.g.
`int`	`getPort()` Return port subcomponent of `HttpAddress.authority`, e.g.
`java.lang.String`	`getQuery()` Return (nullable) Optional query component, e.g.
`java.lang.String`	`getScheme()` Return scheme component, e.g.
`static boolean`	`isAbsolute(java.lang.String address)` Return `true` if `address` is absolute.
`static boolean`	`isRelative(java.lang.String address)` Return `true` if `address` is relative.
`static HttpAddress`	`parse(java.lang.String url)` See parse(String, boolean).
`static HttpAddress`	`parse(java.lang.String url, boolean absolute)` Parse a URL.
`java.lang.String`	`pathAndQuery()` Return the path and query portions of the address, e.g.
`HttpAddress`	`relativeTo(HttpAddress other)` If this address is absolute, then return it.
`java.lang.String`	`schemeAndAuthority()` Return the scheme and authority portions of the address, e.g.
`void`	`setAbsolute(boolean value)` Set true for absolute URL, `false` for relative URL.
`void`	`setAuthority(java.lang.String value)` Set authority component, e.g.
`void`	`setFragment(java.lang.String value)` Set optional fragment component, e.g.
`void`	`setHost(java.lang.String value)` Set host subcomponent of `HttpAddress.authority`, e.g.
`void`	`setPath(java.lang.String value)` Set optional path component, e.g.
`void`	`setPort(int value)` Set port subcomponent of `HttpAddress.authority`, e.g.
`void`	`setQuery(java.lang.String value)` Set optional query component, e.g.
`void`	`setScheme(java.lang.String value)` Set scheme component, e.g.
`java.lang.String`	`toString()` Return the URL in string form, e.g.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HttpAddress
```
public HttpAddress()
```
- Method Detail
  - getAbsolute
```
public boolean getAbsolute()
```
    Return true for absolute URL, false for relative URL.
    
    Returns:
    
    True for absolute URL, false for relative URL.
  - getAuthority
```
public java.lang.String getAuthority()
```
    Return (nullable) Authority component, e.g. host ("myhost") or host and port ("myhost:8080").
    
    Returns:
    
    (nullable) Authority component, e.g. host ("myhost") or host and port ("myhost:8080").
  - getFragment
```
public java.lang.String getFragment()
```
    Return (nullable) Optional fragment component, e.g. "#myfragment".
    
    Returns:
    
    (nullable) Optional fragment component, e.g. "#myfragment".
  - getHost
```
public java.lang.String getHost()
```
    Return host subcomponent of HttpAddress.authority, e.g. "myhost".
    
    Returns:
    
    Host subcomponent of HttpAddress.authority, e.g. "myhost".
  - getPath
```
public java.lang.String getPath()
```
    Return (nullable) Optional path component, e.g. "/mypath".
    
    Returns:
    
    (nullable) Optional path component, e.g. "/mypath".
  - getPort
```
public int getPort()
```
    Return port subcomponent of HttpAddress.authority, e.g. 8080.
    
    Returns:
    
    Port subcomponent of HttpAddress.authority, e.g. 8080.
  - getQuery
```
public java.lang.String getQuery()
```
    Return (nullable) Optional query component, e.g. "?myquery".
    
    Returns:
    
    (nullable) Optional query component, e.g. "?myquery".
  - getScheme
```
public java.lang.String getScheme()
```
    Return scheme component, e.g. "http" or "https".
    
    Returns:
    
    Scheme component, e.g. "http" or "https".
  - isAbsolute
```
public static boolean isAbsolute(java.lang.String address)
```
    Return true if address is absolute.
    
    Parameters:
    
    address - Absolute or relative URL.
    
    Returns:
    
    true if address is absolute.
  - isRelative
```
public static boolean isRelative(java.lang.String address)
```
    Return true if address is relative.
    
    Parameters:
    
    address - Absolute or relative URL.
    
    Returns:
    
    true if address is relative.
  - parse
```
public static HttpAddress parse(java.lang.String url)
```
    See parse(String, boolean).
    
    Parameters:
    
    url - Url parameter.
    
    Returns:
    
    (see linked method).
  - parse
```
public static HttpAddress parse(java.lang.String url,
                                boolean absolute)
```
    Parse a URL.
    
    See Also:
    
    URL.
    
    Parameters:
    
    url - The address URL.
    
    absolute - `true` if the `url` must be absolute. False if the `url` may be relative.
    
    Returns:
    
    A new parsed HTTP address.
  - pathAndQuery
```
public java.lang.String pathAndQuery()
```
    Return the path and query portions of the address, e.g. "/mypath?myquery".
    
    Returns:
    
    The path and query portions of the address, e.g. "/mypath?myquery".
  - relativeTo
```
public HttpAddress relativeTo(HttpAddress other)
```
    If this address is absolute, then return it. If this address is relative, then apply it to other and rerturn the resulting address.
    
    Parameters:
    
    other - Other HTTP address.
    
    Returns:
    
    This address (if absolute), or this address applied to other.
  - schemeAndAuthority
```
public java.lang.String schemeAndAuthority()
```
    Return the scheme and authority portions of the address, e.g. "http://myhost:8080".
    
    Returns:
    
    The scheme and authority portions of the address, e.g. "http://myhost:8080".
  - setAbsolute
```
public void setAbsolute(boolean value)
```
    Set true for absolute URL, false for relative URL.
    
    Parameters:
    
    value - True for absolute URL, false for relative URL.
  - setAuthority
```
public void setAuthority(java.lang.String value)
```
    Set authority component, e.g. host ("myhost") or host and port ("myhost:8080").
    
    Parameters:
    
    value - Authority component, e.g. host ("myhost") or host and port ("myhost:8080").
  - setFragment
```
public void setFragment(java.lang.String value)
```
    Set optional fragment component, e.g. "#myfragment".
    
    Parameters:
    
    value - Optional fragment component, e.g. "#myfragment".
  - setHost
```
public void setHost(java.lang.String value)
```
    Set host subcomponent of HttpAddress.authority, e.g. "myhost".
    
    Parameters:
    
    value - Host subcomponent of HttpAddress.authority, e.g. "myhost".
  - setPath
```
public void setPath(java.lang.String value)
```
    Set optional path component, e.g. "/mypath".
    
    Parameters:
    
    value - Optional path component, e.g. "/mypath".
  - setPort
```
public void setPort(int value)
```
    Set port subcomponent of HttpAddress.authority, e.g. 8080.
    
    Parameters:
    
    value - Port subcomponent of HttpAddress.authority, e.g. 8080.
  - setQuery
```
public void setQuery(java.lang.String value)
```
    Set optional query component, e.g. "?myquery".
    
    Parameters:
    
    value - Optional query component, e.g. "?myquery".
  - setScheme
```
public void setScheme(java.lang.String value)
```
    Set scheme component, e.g. "http" or "https".
    
    Parameters:
    
    value - Scheme component, e.g. "http" or "https".
  - toString
```
public java.lang.String toString()
```
    Return the URL in string form, e.g. "http://myhost:8080/path?query#fragment".
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The URL in string form, e.g. "http://myhost:8080/path?query#fragment".

Class HttpAddress

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpAddress

Method Detail

getAbsolute

getAuthority

getFragment

getHost

getPath

getPort

getQuery

getScheme

isAbsolute

isRelative

parse

parse

pathAndQuery

relativeTo

schemeAndAuthority

setAbsolute

setAuthority

setFragment

setHost

setPath

setPort

setQuery

setScheme

toString