AccessCondition (Microsoft Azure SDK for Media Services 0.9.8 API)

java.lang.Object
- com.microsoft.windowsazure.services.blob.models.AccessCondition

```
public final class AccessCondition
extends Object
```
Represents a set of access conditions to be used for operations against the storage services.

Constructor Summary

Constructors
Constructor and Description

AccessCondition()
Creates an instance of the AccessCondition class.

Constructors
Constructor and Description
`AccessCondition()` Creates an instance of the `AccessCondition` class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addOptionalHeader(HttpURLConnection request, String name, String value)` Adds the optional header.
`void`	`applyConditionToRequest(HttpURLConnection request)` RESERVED FOR INTERNAL USE.
`void`	`applyConditionToRequest(HttpURLConnection request, boolean useSourceAccessHeaders)` RESERVED FOR INTERNAL USE.
`static AccessCondition`	`generateEmptyCondition()` Generates a new empty AccessCondition.
`static AccessCondition`	`generateIfMatchCondition(String etag)` Returns an access condition such that an operation will be performed only if the resource's ETag value matches the specified ETag value.
`static AccessCondition`	`generateIfModifiedSinceCondition(Date lastMotified)` Returns an access condition such that an operation will be performed only if the resource has been modified since the specified time.
`static AccessCondition`	`generateIfNoneMatchCondition(String etag)` Returns an access condition such that an operation will be performed only if the resource's ETag value does not match the specified ETag value.
`static AccessCondition`	`generateIfNotModifiedSinceCondition(Date lastMotified)` Returns an access condition such that an operation will be performed only if the resource has not been modified since the specified time.
`static AccessCondition`	`generateLeaseCondition(String leaseID)` Returns an access condition such that an operation will be performed only if the resource is accessible under the specified lease id.
`String`	`getIfMatch()`
`Date`	`getIfModifiedSinceDate()`
`String`	`getIfNoneMatch()`
`Date`	`getIfUnmodifiedSinceDate()`
`String`	`getLeaseID()`
`void`	`setIfMatch(String etag)`
`void`	`setIfModifiedSinceDate(Date ifModifiedSinceDate)`
`void`	`setIfNoneMatch(String etag)`
`void`	`setIfUnmodifiedSinceDate(Date ifUnmodifiedSinceDate)`
`void`	`setLeaseID(String leaseID)`
`boolean`	`verifyConditional(String etag, Date lastModified)` Reserved for internal use.

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

- Constructor Detail
  - AccessCondition
```
public AccessCondition()
```
    Creates an instance of the AccessCondition class.
- Method Detail
  - generateEmptyCondition
```
public static AccessCondition generateEmptyCondition()
```
    Generates a new empty AccessCondition.
    For more information, see Specifying Conditional Headers for Blob Service Operations.
    
    Returns:
    
    An AccessCondition object that has no conditions set.
  - generateIfMatchCondition
```
public static AccessCondition generateIfMatchCondition(String etag)
```
    Returns an access condition such that an operation will be performed only if the resource's ETag value matches the specified ETag value.
    Setting this access condition modifies the request to include the HTTP If-Match conditional header. If this access condition is set, the operation is performed only if the ETag of the resource matches the specified ETag.
    For more information, see Specifying Conditional Headers for Blob Service Operations.
    
    Parameters:
    
    etag - A String that represents the ETag value to check.
    
    Returns:
    
    An AccessCondition object that represents the If-Match condition.
  - generateIfModifiedSinceCondition
```
public static AccessCondition generateIfModifiedSinceCondition(Date lastMotified)
```
    Returns an access condition such that an operation will be performed only if the resource has been modified since the specified time.
    Setting this access condition modifies the request to include the HTTP If-Modified-Since conditional header. If this access condition is set, the operation is performed only if the resource has been modified since the specified time.
    For more information, see Specifying Conditional Headers for Blob Service Operations.
    
    Parameters:
    
    lastMotified - A java.util.Date object that represents the last-modified time to check for the resource.
    
    Returns:
    
    An AccessCondition object that represents the If-Modified-Since condition.
  - generateIfNoneMatchCondition
```
public static AccessCondition generateIfNoneMatchCondition(String etag)
```
    Returns an access condition such that an operation will be performed only if the resource's ETag value does not match the specified ETag value.
    Setting this access condition modifies the request to include the HTTP If-None-Match conditional header. If this access condition is set, the operation is performed only if the ETag of the resource does not match the specified ETag.
    For more information, see Specifying Conditional Headers for Blob Service Operations.
    
    Parameters:
    
    etag - A String that represents the ETag value to check.
    
    Returns:
    
    An AccessCondition object that represents the If-None-Match condition.
  - generateIfNotModifiedSinceCondition
```
public static AccessCondition generateIfNotModifiedSinceCondition(Date lastMotified)
```
    Returns an access condition such that an operation will be performed only if the resource has not been modified since the specified time.
    Setting this access condition modifies the request to include the HTTP If-Unmodified-Since conditional header. If this access condition is set, the operation is performed only if the resource has not been modified since the specified time.
    For more information, see Specifying Conditional Headers for Blob Service Operations.
    
    Parameters:
    
    lastMotified - A java.util.Date object that represents the last-modified time to check for the resource.
    
    Returns:
    
    An AccessCondition object that represents the If-Unmodified-Since condition.
  - generateLeaseCondition
```
public static AccessCondition generateLeaseCondition(String leaseID)
```
    Returns an access condition such that an operation will be performed only if the resource is accessible under the specified lease id.
    Setting this access condition modifies the request to include the HTTP If-Unmodified-Since conditional header. If this access condition is set, the operation is performed only if the resource has not been modified since the specified time.
    For more information, see Specifying Conditional Headers for Blob Service Operations.
    
    Parameters:
    
    leaseID - The lease id to specify.
  - applyConditionToRequest
```
public void applyConditionToRequest(HttpURLConnection request)
```
    RESERVED FOR INTERNAL USE. Applies the access condition to the request.
    
    Parameters:
    
    request - A java.net.HttpURLConnection object that represents the request to which the condition is being applied.
    
    Throws:
    
    StorageException - If there is an error parsing the date value of the access condition.
  - applyConditionToRequest
```
public void applyConditionToRequest(HttpURLConnection request,
                                    boolean useSourceAccessHeaders)
```
    RESERVED FOR INTERNAL USE. Applies the access condition to the request.
    
    Parameters:
    
    request - A java.net.HttpURLConnection object that represents the request to which the condition is being applied.
    
    useSourceAccessHeaders - If true will use the Source_ headers for the conditions, otherwise standard headers are used.
    
    Throws:
    
    StorageException - If there is an error parsing the date value of the access condition.
  - getIfMatch
```
public String getIfMatch()
```
    Returns:
    
    the etag when the If-Match condition is set.
  - getIfModifiedSinceDate
```
public Date getIfModifiedSinceDate()
```
    Returns:
    
    the ifModifiedSinceDate
  - getIfNoneMatch
```
public String getIfNoneMatch()
```
    Returns:
    
    the etag when the If-None-Match condition is set.
  - getIfUnmodifiedSinceDate
```
public Date getIfUnmodifiedSinceDate()
```
    Returns:
    
    the ifUnmodifiedSinceDate
  - getLeaseID
```
public String getLeaseID()
```
    Returns:
    
    the leaseID
  - setIfMatch
```
public void setIfMatch(String etag)
```
    Parameters:
    
    etag - the etag to set
  - setIfModifiedSinceDate
```
public void setIfModifiedSinceDate(Date ifModifiedSinceDate)
```
    Parameters:
    
    ifModifiedSinceDate - the ifModifiedSinceDate to set
  - setIfNoneMatch
```
public void setIfNoneMatch(String etag)
```
    Parameters:
    
    etag - the etag to set
  - setIfUnmodifiedSinceDate
```
public void setIfUnmodifiedSinceDate(Date ifUnmodifiedSinceDate)
```
    Parameters:
    
    ifUnmodifiedSinceDate - the ifUnmodifiedSinceDate to set
  - setLeaseID
```
public void setLeaseID(String leaseID)
```
    Parameters:
    
    leaseID - the leaseID to set
  - verifyConditional
```
public boolean verifyConditional(String etag,
                                 Date lastModified)
```
    Reserved for internal use. Verifies the condition is satisfied.
    
    Parameters:
    
    etag - A String that represents the ETag to check.
    
    lastModified - A java.util.Date object that represents the last modified date/time.
    
    Returns:
    
    true if the condition is satisfied; otherwise, false.
  - addOptionalHeader
```
public static void addOptionalHeader(HttpURLConnection request,
                                     String name,
                                     String value)
```
    Adds the optional header.
    
    Parameters:
    
    request - a HttpURLConnection for the operation.
    
    name - the metadata name.
    
    value - the metadata value.

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Class AccessCondition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AccessCondition

Method Detail

generateEmptyCondition

generateIfMatchCondition

generateIfModifiedSinceCondition

generateIfNoneMatchCondition

generateIfNotModifiedSinceCondition

generateLeaseCondition

applyConditionToRequest

applyConditionToRequest

getIfMatch

getIfModifiedSinceDate

getIfNoneMatch

getIfUnmodifiedSinceDate

getLeaseID

setIfMatch

setIfModifiedSinceDate

setIfNoneMatch

setIfUnmodifiedSinceDate

setLeaseID

verifyConditional

addOptionalHeader