BaseHttpRequestOptions (Apache jclouds 2.0.0 API)

java.lang.Object
- org.jclouds.http.options.BaseHttpRequestOptions

All Implemented Interfaces:

HttpRequestOptions

Direct Known Subclasses:

AccountInDomainOptions, AddClusterOptions, AddHostOptions, AddLoadBalancerOptions, AddRecordOptions, AddSecondaryStorageOptions, AddServerOptions, AssumeRoleOptions, AttachOptions, BaseEC2RequestOptions, BaseListOptions, BuildOptions, CommitOptions, CopyObjectOptions, CopyOptions, CreateAccountOptions, CreateAccountOptions, CreateContainerOptions, CreateDomainOptions, CreateFirewallRuleOptions, CreateImageOptions, CreateIPForwardingRuleOptions, CreateOptions, CreatePodOptions, CreateQueueOptions, CreateTagsOptions, CreateTemplateOptions, CreateUserOptions, CreateVMGroupOptions, CreateZoneOptions, DeleteHostOptions, DeleteImageOptions, DeleteISOOptions, DeleteTagsOptions, DeleteTemplateOptions, DestroyServerOptions, DomainOptions, ExtractISOOptions, ExtractTemplateOptions, FederatedUserOptions, GenerateUsageRecordsOptions, GetImageListOptions, GetIpListOptions, GetJobListOptions, GetMetricStatisticsOptions, GetOptions, GetServerListOptions, ListAlarmHistoryOptions, ListAlarmsForMetric, ListAlarmsOptions, ListAlertsOptions, ListBucketOptions, ListCapacityOptions, ListCDNContainerOptions, ListClustersOptions, ListConfigurationEntriesOptions, ListContainerOptions, ListContainerOptions, ListDiskOfferingsOptions, ListDomainChildrenOptions, ListDomainsOptions, ListEventsOptions, ListImageOptions, ListIpOptions, ListMetricsOptions, ListNetworkOfferingsOptions, ListOptions, ListOptions, ListOptions, ListOptions, ListOptions, ListOSTypesOptions, ListPodsOptions, ListQueuesOptions, ListResourceLimitsOptions, ListServiceOfferingsOptions, ListSSHKeyPairsOptions, ListStoragePoolsOptions, ListVMGroupsOptions, ListZonesOptions, PaginationOptions, PutBucketOptions, PutObjectOptions, PutOptions, PutOptions, ReceiveMessageOptions, RemoveContainerOptions, SaveAlarmOptions, SaveImageOptions, SearchOptions, SendMessageOptions, ServerStatusOptions, SessionCredentialsOptions, StopVirtualMachineOptions, UpdateAccountOptions, UpdateCDNContainerOptions, UpdateClusterOptions, UpdateContainerOptions, UpdateDomainOptions, UpdateHostOptions, UpdateImageOptions, UpdateISOOptions, UpdateISOPermissionsOptions, UpdateLoadBalancerRuleOptions, UpdatePodOptions, UpdateServerOptions, UpdateTemplateOptions, UpdateTemplatePermissionsOptions, UpdateUserOptions, UpdateVirtualMachineOptions, UpdateVMGroupOptions, UpdateZoneOptions
```
public class BaseHttpRequestOptions
extends Object
implements HttpRequestOptions
```
See Also:
HttpRequestOptions

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.google.common.collect.Multimap<String,String>`	`formParameters`
`protected com.google.common.collect.Multimap<String,String>`	`headers`
`protected String`	`pathSuffix`
`protected String`	`payload`
`protected com.google.common.collect.Multimap<String,String>`	`queryParameters`

Constructor Summary

Constructors
Constructor and Description

BaseHttpRequestOptions()

Constructors
Constructor and Description
`BaseHttpRequestOptions()`

Method Summary

Methods
Modifier and Type	Method and Description
`com.google.common.collect.Multimap<String,String>`	`buildFormParameters()` Builds form parameters representing options.
`String`	`buildPathSuffix()`
`com.google.common.collect.Multimap<String,String>`	`buildQueryParameters()` Builds query parameters representing options.
`com.google.common.collect.Multimap<String,String>`	`buildRequestHeaders()` Builds headers representing options.
`String`	`buildStringPayload()`
`boolean`	`equals(Object obj)`
`protected String`	`getFirstFormOrNull(String string)`
`protected String`	`getFirstHeaderOrNull(String string)`
`protected String`	`getFirstQueryOrNull(String string)`
`int`	`hashCode()`
`protected void`	`replaceHeader(String key, String value)`
`String`	`toString()`

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

Field Detail

formParameters

protected final com.google.common.collect.Multimap<String,String> formParameters

queryParameters

protected final com.google.common.collect.Multimap<String,String> queryParameters

headers

protected final com.google.common.collect.Multimap<String,String> headers

payload
```
protected String payload
```

pathSuffix
```
protected String pathSuffix
```

Constructor Detail
- BaseHttpRequestOptions
```
public BaseHttpRequestOptions()
```

Method Detail
- buildStringPayload
```
public String buildStringPayload()
```
  Specified by:
  
  buildStringPayload in interface HttpRequestOptions
- getFirstQueryOrNull
```
protected String getFirstQueryOrNull(String string)
```
- getFirstFormOrNull
```
protected String getFirstFormOrNull(String string)
```
- getFirstHeaderOrNull
```
protected String getFirstHeaderOrNull(String string)
```
- replaceHeader
```
protected void replaceHeader(String key,
                 String value)
```
- buildRequestHeaders
```
public com.google.common.collect.Multimap<String,String> buildRequestHeaders()
```
  Builds headers representing options.
  
  Specified by:
  
  buildRequestHeaders in interface HttpRequestOptions
  
  Returns:
  multimap that may contain headers.
- buildQueryParameters
```
public com.google.common.collect.Multimap<String,String> buildQueryParameters()
```
  Builds query parameters representing options.
  
  Specified by:
  
  buildQueryParameters in interface HttpRequestOptions
  
  Returns:
  map that may contain query parameters.
- buildPathSuffix
```
public String buildPathSuffix()
```
  Specified by:
  
  buildPathSuffix in interface HttpRequestOptions
- buildFormParameters
```
public com.google.common.collect.Multimap<String,String> buildFormParameters()
```
  Description copied from interface: HttpRequestOptions
  
  Builds form parameters representing options.
  
  Specified by:
  
  buildFormParameters in interface HttpRequestOptions
  
  Returns:
  map that may contain query parameters.
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- equals
```
public boolean equals(Object obj)
```
  Overrides:
  
  equals in class Object
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object

Class BaseHttpRequestOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

formParameters

queryParameters

headers

payload

pathSuffix

Constructor Detail

BaseHttpRequestOptions

Method Detail

buildStringPayload

getFirstQueryOrNull

getFirstFormOrNull

getFirstHeaderOrNull

replaceHeader

buildRequestHeaders

buildQueryParameters

buildPathSuffix

buildFormParameters

hashCode

equals

toString