AccessCondition (Microsoft Azure Libraries for Java)

java.lang.Object
- com.microsoft.azure.storage.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
`void`	`applyAppendConditionToRequest(HttpURLConnection request)` RESERVED FOR INTERNAL USE.
`void`	`applyConditionToRequest(HttpURLConnection request)` RESERVED FOR INTERNAL USE.
`void`	`applyLeaseConditionToRequest(HttpURLConnection request)` RESERVED FOR INTERNAL USE.
`void`	`applySequenceConditionToRequest(HttpURLConnection request)` RESERVED FOR INTERNAL USE.
`void`	`applySourceConditionToRequest(HttpURLConnection request)` RESERVED FOR INTERNAL USE.
`static AccessCondition`	`generateEmptyCondition()` Generates a new empty AccessCondition.
`static AccessCondition`	`generateIfExistsCondition()` Returns an access condition such that an operation will be performed only if the resource exists on the service.
`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`	`generateIfNotExistsCondition()` Returns an access condition such that an operation will be performed only if the resource does not exist on the service.
`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`	`generateIfSequenceNumberEqualCondition(long sequenceNumber)` Returns an access condition such that an operation will be performed only if resource's current sequence number is equal to the specified value.
`static AccessCondition`	`generateIfSequenceNumberLessThanCondition(long sequenceNumber)` Returns an access condition such that an operation will be performed only if resource's current sequence number is less than the specified value.
`static AccessCondition`	`generateIfSequenceNumberLessThanOrEqualCondition(long sequenceNumber)` Returns an access condition such that an operation will be performed only if resource's current sequence number is less than or equal to the specified value.
`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.
`Long`	`getIfAppendPositionEqual()` Gets the value for a conditional header used only for append operations.
`String`	`getIfMatch()` Gets the ETag when the If-Match condition is set.
`Long`	`getIfMaxSizeLessThanOrEqual()` Gets the value for a conditional header used only for append operations.
`Date`	`getIfModifiedSinceDate()` Gets the If-Modified-Since date.
`String`	`getIfNoneMatch()` Gets the ETag when the If-None-Match condition is set.
`Long`	`getIfSequenceNumberEqual()` Gets the sequence number when the sequence number equal condition is set.
`Long`	`getIfSequenceNumberLessThan()` Gets the sequence number when the sequence number less than condition is set.
`Long`	`getIfSequenceNumberLessThanOrEqual()` Gets the sequence number when the sequence number less than or equal condition is set.
`Date`	`getIfUnmodifiedSinceDate()` Gets the If-Unmodified-Since date.
`String`	`getLeaseID()` Gets the lease ID.
`void`	`setIfAppendPositionEqual(Long ifAppendPositionEqual)` Sets the value for a conditional header used only for append operations.
`void`	`setIfMatch(String etag)` Sets the ETag for the If-Match condition.
`void`	`setIfMaxSizeLessThanOrEqual(Long ifMaxSizeLessThanOrEqual)` Sets the value for a conditional header used only for append operations.
`void`	`setIfModifiedSinceDate(Date ifModifiedSinceDate)` Sets the If-Modified-Since date.
`void`	`setIfNoneMatch(String etag)` Sets the ETag for the If-None-Match condition.
`void`	`setIfSequenceNumberEqual(Long sequenceNumber)` Sets the sequence number for the sequence number equal to condition.
`void`	`setIfSequenceNumberLessThan(Long sequenceNumber)` Sets the sequence number for the sequence number less than condition.
`void`	`setIfSequenceNumberLessThanOrEqual(Long sequenceNumber)` Sets the sequence number for the sequence number less than or equal to condition.
`void`	`setIfUnmodifiedSinceDate(Date ifUnmodifiedSinceDate)` Sets the If-Unmodified-Since date.
`void`	`setLeaseID(String leaseID)` Gets the lease ID.
`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.
  - generateIfSequenceNumberLessThanOrEqualCondition
```
public static AccessCondition generateIfSequenceNumberLessThanOrEqualCondition(long sequenceNumber)
```
    Returns an access condition such that an operation will be performed only if resource's current sequence number is less than or equal to the specified value. This condition only applies to page blobs.
    
    Parameters:
    
    sequenceNumber - The value to compare to the current sequence number.
    
    Returns:
    
    An AccessCondition object that represents the If-Sequence-Number-LE condition.
  - generateIfSequenceNumberLessThanCondition
```
public static AccessCondition generateIfSequenceNumberLessThanCondition(long sequenceNumber)
```
    Returns an access condition such that an operation will be performed only if resource's current sequence number is less than the specified value. This condition only applies to page blobs.
    
    Parameters:
    
    sequenceNumber - The value to compare to the current sequence number.
    
    Returns:
    
    An AccessCondition object that represents the If-Sequence-Number-LT condition.
  - generateIfSequenceNumberEqualCondition
```
public static AccessCondition generateIfSequenceNumberEqualCondition(long sequenceNumber)
```
    Returns an access condition such that an operation will be performed only if resource's current sequence number is equal to the specified value. This condition only applies to page blobs.
    
    Parameters:
    
    sequenceNumber - The value to compare to the current sequence number.
    
    Returns:
    
    An AccessCondition object that represents the If-Sequence-Number-EQ 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.
    For more information, see Specifying Conditional Headers for Blob Service Operations.
    
    Parameters:
    
    leaseID - The lease ID to specify.
    
    Returns:
    
    An AccessCondition object that represents the lease condition.
  - generateIfExistsCondition
```
public static AccessCondition generateIfExistsCondition()
```
    Returns an access condition such that an operation will be performed only if the resource exists on the service.
    Setting this access condition modifies the request to include the HTTP If-Match conditional header.
    For more information, see Specifying Conditional Headers for Blob Service Operations.
    
    Returns:
    
    An AccessCondition object that represents the if exists condition.
  - generateIfNotExistsCondition
```
public static AccessCondition generateIfNotExistsCondition()
```
    Returns an access condition such that an operation will be performed only if the resource does not exist on the service.
    Setting this access condition modifies the request to include the HTTP If-None-Match conditional header.
    For more information, see Specifying Conditional Headers for Blob Service Operations.
    
    Returns:
    
    An AccessCondition object that represents the if not exists condition.
  - applyConditionToRequest
```
public void applyConditionToRequest(HttpURLConnection request)
```
    RESERVED FOR INTERNAL USE. Applies the access conditions to the request.
    
    Parameters:
    
    request - A java.net.HttpURLConnection object that represents the request to which the condition is being applied.
  - applySourceConditionToRequest
```
public void applySourceConditionToRequest(HttpURLConnection request)
```
    RESERVED FOR INTERNAL USE. Applies the source access conditions to the request.
    
    Parameters:
    
    request - A java.net.HttpURLConnection object that represents the request to which the condition is being applied.
  - applyAppendConditionToRequest
```
public void applyAppendConditionToRequest(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.
  - applyLeaseConditionToRequest
```
public void applyLeaseConditionToRequest(HttpURLConnection request)
```
    RESERVED FOR INTERNAL USE. Applies the lease access condition to the request.
    
    Parameters:
    
    request - A java.net.HttpURLConnection object that represents the request to which the condition is being applied.
  - applySequenceConditionToRequest
```
public void applySequenceConditionToRequest(HttpURLConnection request)
```
    RESERVED FOR INTERNAL USE. Applies the sequence number access conditions to the request.
    
    Parameters:
    
    request - A java.net.HttpURLConnection object that represents the request to which the condition is being applied.
  - getIfAppendPositionEqual
```
public Long getIfAppendPositionEqual()
```
    Gets the value for a conditional header used only for append operations. A number indicating the byte offset to check for. The append will succeed only if the end position is equal to this number.
    
    Returns:
    
    The append position number, or null if no condition exists.
  - getIfMatch
```
public String getIfMatch()
```
    Gets the ETag when the If-Match condition is set.
    
    Returns:
    
    The ETag when the If-Match condition is set; otherwise, null.
  - getIfMaxSizeLessThanOrEqual
```
public Long getIfMaxSizeLessThanOrEqual()
```
    Gets the value for a conditional header used only for append operations. A number that indicates the maximum length in bytes to restrict the blob to when committing the block.
    
    Returns:
    
    The maximum size, or null if no condition exists.
  - getIfModifiedSinceDate
```
public Date getIfModifiedSinceDate()
```
    Gets the If-Modified-Since date.
    
    Returns:
    
    A java.util.Date object that represents the If-Modified-Since date.
  - getIfNoneMatch
```
public String getIfNoneMatch()
```
    Gets the ETag when the If-None-Match condition is set.
    
    Returns:
    
    The ETag when the If-None-Match condition is set; otherwise, null.
  - getIfUnmodifiedSinceDate
```
public Date getIfUnmodifiedSinceDate()
```
    Gets the If-Unmodified-Since date.
    
    Returns:
    
    A java.util.Date object that represents the If-Unmodified-Since date.
  - getLeaseID
```
public String getLeaseID()
```
    Gets the lease ID.
    
    Returns:
    
    The lease ID.
  - getIfSequenceNumberLessThanOrEqual
```
public Long getIfSequenceNumberLessThanOrEqual()
```
    Gets the sequence number when the sequence number less than or equal condition is set. This condition is only applicable to page blobs.
    
    Returns:
    
    The sequence number when the ifSequenceNumberLessThanOrEqual condition is set; otherwise, null
  - getIfSequenceNumberLessThan
```
public Long getIfSequenceNumberLessThan()
```
    Gets the sequence number when the sequence number less than condition is set. This condition is only applicable to page blobs.
    
    Returns:
    
    The sequence number when the ifSequenceNumberLessThan condition is set; otherwise, null
  - getIfSequenceNumberEqual
```
public Long getIfSequenceNumberEqual()
```
    Gets the sequence number when the sequence number equal condition is set. This condition is only applicable to page blobs.
    
    Returns:
    
    The sequence number when the ifSequenceNumberEqual condition is set; otherwise, null
  - setIfAppendPositionEqual
```
public void setIfAppendPositionEqual(Long ifAppendPositionEqual)
```
    Sets the value for a conditional header used only for append operations. A number indicating the byte offset to check for. The append will succeed only if the end position is equal to this number.
    
    Parameters:
    
    ifAppendPositionEqual - The append position number, or null if no condition exists.
  - setIfMatch
```
public void setIfMatch(String etag)
```
    Sets the ETag for the If-Match condition.
    
    Parameters:
    
    etag - The ETag to set for the If-Match condition.
  - setIfMaxSizeLessThanOrEqual
```
public void setIfMaxSizeLessThanOrEqual(Long ifMaxSizeLessThanOrEqual)
```
    Sets the value for a conditional header used only for append operations. A number that indicates the maximum length in bytes to restrict the blob to when committing the block.
    
    Parameters:
    
    ifMaxSizeLessThanOrEqual - The maximum size, or null if no condition exists.
  - setIfModifiedSinceDate
```
public void setIfModifiedSinceDate(Date ifModifiedSinceDate)
```
    Sets the If-Modified-Since date.
    
    Parameters:
    
    ifModifiedSinceDate - A java.util.Date object that represents the If-Modified-Since to set.
  - setIfNoneMatch
```
public void setIfNoneMatch(String etag)
```
    Sets the ETag for the If-None-Match condition.
    
    Parameters:
    
    etag - The ETag to set for the If-None-Match condition.
  - setIfUnmodifiedSinceDate
```
public void setIfUnmodifiedSinceDate(Date ifUnmodifiedSinceDate)
```
    Sets the If-Unmodified-Since date.
    
    Parameters:
    
    ifUnmodifiedSinceDate - A java.util.Date object that represents the If-Unmodified-Since to set.
  - setLeaseID
```
public void setLeaseID(String leaseID)
```
    Gets the lease ID.
    
    Parameters:
    
    leaseID - The lease ID to set.
  - setIfSequenceNumberLessThanOrEqual
```
public void setIfSequenceNumberLessThanOrEqual(Long sequenceNumber)
```
    Sets the sequence number for the sequence number less than or equal to condition. This condition is only applicable to page blobs.
    
    Parameters:
    
    sequenceNumber - The sequence number to set the if sequence number less than or equal condition to.
  - setIfSequenceNumberLessThan
```
public void setIfSequenceNumberLessThan(Long sequenceNumber)
```
    Sets the sequence number for the sequence number less than condition. This condition is only applicable to page blobs.
    
    Parameters:
    
    sequenceNumber - The sequence number to set the if sequence number less than condition to.
  - setIfSequenceNumberEqual
```
public void setIfSequenceNumberEqual(Long sequenceNumber)
```
    Sets the sequence number for the sequence number equal to condition. This condition is only applicable to page blobs.
    
    Parameters:
    
    sequenceNumber - The sequence number to set the if sequence number equal condition to.
  - 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.

Class AccessCondition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AccessCondition

Method Detail

generateEmptyCondition

generateIfMatchCondition

generateIfModifiedSinceCondition

generateIfNoneMatchCondition

generateIfNotModifiedSinceCondition

generateIfSequenceNumberLessThanOrEqualCondition

generateIfSequenceNumberLessThanCondition

generateIfSequenceNumberEqualCondition

generateLeaseCondition

generateIfExistsCondition

generateIfNotExistsCondition

applyConditionToRequest

applySourceConditionToRequest

applyAppendConditionToRequest

applyLeaseConditionToRequest

applySequenceConditionToRequest

getIfAppendPositionEqual

getIfMatch

getIfMaxSizeLessThanOrEqual

getIfModifiedSinceDate

getIfNoneMatch

getIfUnmodifiedSinceDate

getLeaseID

getIfSequenceNumberLessThanOrEqual

getIfSequenceNumberLessThan

getIfSequenceNumberEqual

setIfAppendPositionEqual

setIfMatch

setIfMaxSizeLessThanOrEqual

setIfModifiedSinceDate

setIfNoneMatch

setIfUnmodifiedSinceDate

setLeaseID

setIfSequenceNumberLessThanOrEqual

setIfSequenceNumberLessThan

setIfSequenceNumberEqual

verifyConditional