com.microsoft.azure.storage.StorageUri Java Examples

/**
 * Returns the file's share.
 * 
 * @return A {@link CloudFileShare} object that represents the share of the file.
 * @throws StorageException
 *             If a storage service error occurred.
 * @throws URISyntaxException
 *             If the resource URI is invalid.
 */
@Override
public final CloudFileShare getShare() throws StorageException, URISyntaxException {
    if (this.share == null) {
        final StorageUri shareUri = PathUtility.getShareURI(this.getStorageUri(),
                this.fileServiceClient.isUsePathStyleUris());
        this.share = new CloudFileShare(shareUri, this.fileServiceClient.getCredentials());
    }

    return this.share;
}
 

/**
 * Returns the blob's container.
 *
 * @return A {@link CloudBlobContainer} object that represents the container of the blob.
 * @throws StorageException
 *             If a storage service error occurred.
 * @throws URISyntaxException
 *             If the resource URI is invalid.
 */
@Override
public final CloudBlobContainer getContainer() throws StorageException, URISyntaxException {
    if (this.container == null) {
        final StorageUri containerURI = PathUtility.getContainerURI(this.getStorageUri(),
                this.blobServiceClient.isUsePathStyleUris());
        this.container = new CloudBlobContainer(containerURI, this.blobServiceClient.getCredentials());
    }

    return this.container;
}
 

/**
 * Returns the blob item's parent.
 *
 * @return A {@link CloudBlobDirectory} object that represents the parent directory for the blob.
 *
 * @throws StorageException
 *             If a storage service error occurred.
 * @throws URISyntaxException
 *             If the resource URI is invalid.
 */
@Override
public final CloudBlobDirectory getParent() throws URISyntaxException, StorageException {
    if (this.parent == null) {
        final String parentName = getParentNameFromURI(this.getStorageUri(),
                this.blobServiceClient.getDirectoryDelimiter(), this.getContainer());

        if (parentName != null) {
            StorageUri parentURI = PathUtility.appendPathToUri(this.container.getStorageUri(), parentName);
            this.parent = new CloudBlobDirectory(parentURI, parentName, this.blobServiceClient, this.getContainer());
        }
    }
    return this.parent;
}
 

/**
 * Verifies the passed in URI. Then parses it and uses its components to populate this resource's properties.
 * 
 * @param completeUri
 *            A {@link StorageUri} object which represents the complete URI.
 * @param credentials
 *            A {@link StorageCredentials} object used to authenticate access.
 * @throws StorageException
 *             If a storage service error occurred.
 */
private void parseQueryAndVerify(final StorageUri completeUri, final StorageCredentials credentials)
        throws StorageException {
   Utility.assertNotNull("completeUri", completeUri);

    if (!completeUri.isAbsolute()) {
        throw new IllegalArgumentException(String.format(SR.RELATIVE_ADDRESS_NOT_PERMITTED, completeUri.toString()));
    }

    this.storageUri = PathUtility.stripURIQueryAndFragment(completeUri);

    final HashMap<String, String[]> queryParameters = PathUtility.parseQueryString(completeUri.getQuery());

    final String[] snapshotIDs = queryParameters.get(Constants.QueryConstants.SHARE_SNAPSHOT);
    if (snapshotIDs != null && snapshotIDs.length > 0) {
        this.snapshotID = snapshotIDs[0];
    }

    final StorageCredentialsSharedAccessSignature parsedCredentials = 
            SharedAccessSignatureHelper.parseQuery(completeUri);

    if (credentials != null && parsedCredentials != null) {
        throw new IllegalArgumentException(SR.MULTIPLE_CREDENTIALS_PROVIDED);
    }

    try {
        final boolean usePathStyleUris = Utility.determinePathStyleFromUri(this.storageUri.getPrimaryUri());
        this.fileServiceClient = new CloudFileClient(PathUtility.getServiceClientBaseAddress(
                this.getStorageUri(), usePathStyleUris), credentials != null ? credentials : parsedCredentials);
        this.name = PathUtility.getShareNameFromUri(this.storageUri.getPrimaryUri(), usePathStyleUris);
    }
    catch (final URISyntaxException e) {
        throw Utility.generateNewUnexpectedStorageException(e);
    }
}
 

/**
 * Verifies the passed in URI. Then parses it and uses its components to populate this resource's properties.
 * 
 * @param completeUri
 *            A {@link StorageUri} object which represents the complete URI.
 * @param credentials
 *            A {@link StorageCredentials} object used to authenticate access.
 * @throws StorageException
 *             If a storage service error occurred.
 * @throws URISyntaxException 
 */
private void parseQueryAndVerify(final StorageUri completeUri, final StorageCredentials credentials)
        throws StorageException, URISyntaxException {
   Utility.assertNotNull("completeUri", completeUri);

    if (!completeUri.isAbsolute()) {
        throw new IllegalArgumentException(String.format(SR.RELATIVE_ADDRESS_NOT_PERMITTED, completeUri.toString()));
    }

    this.storageUri = PathUtility.stripURIQueryAndFragment(completeUri);
    
    final StorageCredentialsSharedAccessSignature parsedCredentials = 
            SharedAccessSignatureHelper.parseQuery(completeUri);

    if (credentials != null && parsedCredentials != null) {
        throw new IllegalArgumentException(SR.MULTIPLE_CREDENTIALS_PROVIDED);
    }

    try {
        final boolean usePathStyleUris = Utility.determinePathStyleFromUri(this.storageUri.getPrimaryUri());
        this.fileServiceClient = new CloudFileClient(PathUtility.getServiceClientBaseAddress(
                this.getStorageUri(), usePathStyleUris), credentials != null ? credentials : parsedCredentials);
        this.name = PathUtility.getFileNameFromURI(this.storageUri.getPrimaryUri(), usePathStyleUris);
    }
    catch (final URISyntaxException e) {
        throw Utility.generateNewUnexpectedStorageException(e);
    }

    final HashMap<String, String[]> queryParameters = PathUtility.parseQueryString(completeUri.getQuery());

    final String[] snapshotIDs = queryParameters.get(Constants.QueryConstants.SHARE_SNAPSHOT);
    if (snapshotIDs != null && snapshotIDs.length > 0) {
        this.getShare().snapshotID = snapshotIDs[0];
    }
}
 

/**
 * Get the message request base address (Used internally only).
 * 
 * @return The message request <code>URI</code>.
 * 
 * @throws URISyntaxException
 *             If the resource URI is invalid.
 * @throws StorageException
 */
private StorageUri getMessageRequestAddress(final OperationContext opContext) throws URISyntaxException,
        StorageException {
    if (this.messageRequestAddress == null) {
        this.messageRequestAddress = PathUtility.appendPathToUri(this.getTransformedAddress(opContext),
                QueueConstants.MESSAGES);
    }

    return this.messageRequestAddress;
}
 

/**
 * Returns a reference to a virtual blob directory beneath this directory.
 * 
 * @param directoryName
 *            A <code>String</code> that represents the name of the virtual subdirectory.
 * 
 * @return A <code>CloudBlobDirectory</code> object that represents a virtual blob directory beneath this directory.
 * 
 * @throws URISyntaxException
 *             If the resource URI is invalid.
 */
public CloudBlobDirectory getDirectoryReference(String directoryName) throws URISyntaxException {
    Utility.assertNotNullOrEmpty("directoryName", directoryName);

    if (!directoryName.endsWith(this.blobServiceClient.getDirectoryDelimiter())) {
        directoryName = directoryName.concat(this.blobServiceClient.getDirectoryDelimiter());
    }
    final String subDirName = this.getPrefix().concat(directoryName);

    final StorageUri address = PathUtility.appendPathToUri(this.storageUri, directoryName,
            this.blobServiceClient.getDirectoryDelimiter());

    return new CloudBlobDirectory(address, subDirName, this.blobServiceClient, this.container, this);
}
 

/**
 * Verifies the passed in URI. Then parses it and uses its components to populate this resource's properties.
 * 
 * @param completeUri
 *            A {@link StorageUri} object which represents the complete URI.
 * @param credentials
 *            A {@link StorageCredentials} object used to authenticate access.
 * @throws StorageException
 *             If a storage service error occurred.
 * @throws URISyntaxException 
 */
private void parseQueryAndVerify(final StorageUri completeUri, final StorageCredentials credentials)
        throws StorageException, URISyntaxException {
   Utility.assertNotNull("completeUri", completeUri);

    if (!completeUri.isAbsolute()) {
        throw new IllegalArgumentException(String.format(SR.RELATIVE_ADDRESS_NOT_PERMITTED, completeUri.toString()));
    }

    this.storageUri = PathUtility.stripURIQueryAndFragment(completeUri);
    
    final StorageCredentialsSharedAccessSignature parsedCredentials = 
            SharedAccessSignatureHelper.parseQuery(completeUri);

    if (credentials != null && parsedCredentials != null) {
        throw new IllegalArgumentException(SR.MULTIPLE_CREDENTIALS_PROVIDED);
    }

    try {
        final boolean usePathStyleUris = Utility.determinePathStyleFromUri(this.storageUri.getPrimaryUri());
        this.fileServiceClient = new CloudFileClient(PathUtility.getServiceClientBaseAddress(
                this.getStorageUri(), usePathStyleUris), credentials != null ? credentials : parsedCredentials);
        this.name = PathUtility.getDirectoryNameFromURI(this.storageUri.getPrimaryUri(), usePathStyleUris);
    }
    catch (final URISyntaxException e) {
        throw Utility.generateNewUnexpectedStorageException(e);
    }

    final HashMap<String, String[]> queryParameters = PathUtility.parseQueryString(completeUri.getQuery());

    final String[] snapshotIDs = queryParameters.get(Constants.QueryConstants.SHARE_SNAPSHOT);
    if (snapshotIDs != null && snapshotIDs.length > 0) {
        this.getShare().snapshotID = snapshotIDs[0];
    }
}
 

@Override
public StorageUri getStorageUri() {
  return null;
}
 

@Override
public StorageUri getStorageUri() {
    throw new NotImplementedException();
}
 

@Override
public StorageUri getStorageUri() {
    throw new NotImplementedException();
}
 

@Override
public StorageUri getStorageUri() {
  return getBlob().getStorageUri();
}
 

@Override
public StorageUri getStorageUri() {
  throw new NotImplementedException();
}
 

@Override
public StorageUri getStorageUri() {
  return getBlob().getStorageUri();
}
 

@Override
public StorageUri getStorageUri() {
  throw new NotImplementedException();
}
 

/**
 * @return the URI to which the request will be sent.
 */
public StorageUri getStorageUri() {
    return this.storageUri;
}
 

protected final StorageUri getTransformedEndPoint(final OperationContext opContext) throws URISyntaxException,
        StorageException {
    return this.getCredentials().transformUri(this.getStorageUri(), opContext);
}
 

/**
 * Gets the CloudFileAttributes from the given request
 *
 * @param request
 *            The response from server.
 * @param resourceURI
 *            The file uri to set.
 * @return the CloudFileAttributes from the given request
 * @throws ParseException
 * @throws URISyntaxException
 */
public static FileAttributes getFileAttributes(final HttpURLConnection request, final StorageUri resourceURI)
        throws URISyntaxException, ParseException {
    final FileAttributes fileAttributes = new FileAttributes();
    final FileProperties properties = fileAttributes.getProperties();

    properties.setCacheControl(request.getHeaderField(Constants.HeaderConstants.CACHE_CONTROL));
    properties.setContentDisposition(request.getHeaderField(Constants.HeaderConstants.CONTENT_DISPOSITION));
    properties.setContentEncoding(request.getHeaderField(Constants.HeaderConstants.CONTENT_ENCODING));
    properties.setContentLanguage(request.getHeaderField(Constants.HeaderConstants.CONTENT_LANGUAGE));

    // For range gets, only look at 'x-ms-content-md5' for overall MD5
    if (!Utility.isNullOrEmpty(request.getHeaderField(Constants.HeaderConstants.CONTENT_RANGE))) {
        properties.setContentMD5(request.getHeaderField(FileConstants.FILE_CONTENT_MD5_HEADER));
    }
    else {
        properties.setContentMD5(request.getHeaderField(Constants.HeaderConstants.CONTENT_MD5));
    }

    properties.setContentType(request.getHeaderField(Constants.HeaderConstants.CONTENT_TYPE));
    properties.setEtag(BaseResponse.getEtag(request));
    properties.setCopyState(FileResponse.getCopyState(request));
    properties.setServerEncrypted(
            Constants.TRUE.equals(request.getHeaderField(Constants.HeaderConstants.SERVER_ENCRYPTED)));

    final Calendar lastModifiedCalendar = Calendar.getInstance(Utility.LOCALE_US);
    lastModifiedCalendar.setTimeZone(Utility.UTC_ZONE);
    lastModifiedCalendar.setTime(new Date(request.getLastModified()));
    properties.setLastModified(lastModifiedCalendar.getTime());

    final String rangeHeader = request.getHeaderField(Constants.HeaderConstants.CONTENT_RANGE);
    final String xContentLengthHeader = request.getHeaderField(FileConstants.CONTENT_LENGTH_HEADER);

    if (!Utility.isNullOrEmpty(rangeHeader)) {
        properties.setLength(Long.parseLong(rangeHeader.split("/")[1]));
    }
    else if (!Utility.isNullOrEmpty(xContentLengthHeader)) {
        properties.setLength(Long.parseLong(xContentLengthHeader));
    }
    else {
        // using this instead of the request property since the request
        // property only returns an int.
        final String contentLength = request.getHeaderField(Constants.HeaderConstants.CONTENT_LENGTH);

        if (!Utility.isNullOrEmpty(contentLength)) {
            properties.setLength(Long.parseLong(contentLength));
        }
    }

    fileAttributes.setStorageUri(resourceURI);
    
    fileAttributes.setMetadata(BaseResponse.getMetadata(request));

    return fileAttributes;
}
 

@Override
protected List<BlobInfo> performListing(final ProcessContext context, final Long minTimestamp) throws IOException {
    String containerName = context.getProperty(AzureStorageUtils.CONTAINER).evaluateAttributeExpressions().getValue();
    String prefix = context.getProperty(PROP_PREFIX).evaluateAttributeExpressions().getValue();
    if (prefix == null) {
        prefix = "";
    }
    final List<BlobInfo> listing = new ArrayList<>();
    try {
        CloudBlobClient blobClient = AzureStorageUtils.createCloudBlobClient(context, getLogger(), null);
        CloudBlobContainer container = blobClient.getContainerReference(containerName);

        final OperationContext operationContext = new OperationContext();
        AzureStorageUtils.setProxy(operationContext, context);

        for (ListBlobItem blob : container.listBlobs(prefix, true, EnumSet.of(BlobListingDetails.METADATA), null, operationContext)) {
            if (blob instanceof CloudBlob) {
                CloudBlob cloudBlob = (CloudBlob) blob;
                BlobProperties properties = cloudBlob.getProperties();
                StorageUri uri = cloudBlob.getSnapshotQualifiedStorageUri();

                Builder builder = new BlobInfo.Builder()
                                          .primaryUri(uri.getPrimaryUri().toString())
                                          .blobName(cloudBlob.getName())
                                          .containerName(containerName)
                                          .contentType(properties.getContentType())
                                          .contentLanguage(properties.getContentLanguage())
                                          .etag(properties.getEtag())
                                          .lastModifiedTime(properties.getLastModified().getTime())
                                          .length(properties.getLength());

                if (uri.getSecondaryUri() != null) {
                    builder.secondaryUri(uri.getSecondaryUri().toString());
                }

                if (blob instanceof CloudBlockBlob) {
                    builder.blobType(AzureStorageUtils.BLOCK);
                } else {
                    builder.blobType(AzureStorageUtils.PAGE);
                }
                listing.add(builder.build());
            }
        }
    } catch (Throwable t) {
        throw new IOException(ExceptionUtils.getRootCause(t));
    }
    return listing;
}
 

/**
 * Initializes a new instance of the <code>CloudAnalyticsClient</code> class using the specified blob and table
 * service endpoints and account credentials.
 * 
 * @param blobStorageUri
 *            A {@link StorageUri} object containing the Blob service endpoint to use to create the client.
 * @param tableStorageUri
 *            A {@link StorageUri} object containing the Table service endpoint to use to create the client.
 * @param credentials
 *            A {@link StorageCredentials} object.
 */
public CloudAnalyticsClient(StorageUri blobStorageUri, StorageUri tableStorageUri, StorageCredentials credentials) {
    Utility.assertNotNull("blobStorageUri", blobStorageUri);
    Utility.assertNotNull("tableStorageUri", tableStorageUri);

    this.blobClient = new CloudBlobClient(blobStorageUri, credentials);
    this.tableClient = new CloudTableClient(tableStorageUri, credentials);
}
 

/**
 * Returns the blob's URI for both the primary and secondary locations, including query string information if the blob is a snapshot.
 *
 * @return A {@link StorageUri} object containing the blob's URIs for both the primary and secondary locations, 
 *         including snapshot query information if the blob is a snapshot.
 *
 * @throws StorageException
 *             If a storage service error occurred.
 * @throws URISyntaxException
 *             If the resource URI is invalid.
 */
public final StorageUri getSnapshotQualifiedStorageUri() throws URISyntaxException, StorageException {
    if (this.isSnapshot()) {
        return PathUtility.addToQuery(this.getStorageUri(),
                String.format("snapshot=%s", this.snapshotID));
    }

    return this.getStorageUri();
}
 

/**
 * Creates an instance of the <code>CloudBlob</code> class using the specified URI, snapshot ID, and cloud blob
 * client.
 *
 * @param type
 *            A {@link BlobType} value which represents the type of the blob.
 * @param uri
 *            A {@link StorageUri} object that represents the URI to the blob, beginning with the container name.
 * @param snapshotID
 *            A <code>String</code> that represents the snapshot version, if applicable.
 * @param credentials
 *            A {@link StorageCredentials} object used to authenticate access.
 * @throws StorageException
 *             If a storage service error occurred.
 */
protected CloudBlob(final BlobType type, final StorageUri uri, final String snapshotID,
        final StorageCredentials credentials) throws StorageException {
    this.properties = new BlobProperties(type);
    this.parseQueryAndVerify(uri, credentials);

    if (snapshotID != null) {
        if (this.snapshotID != null) {
            throw new IllegalArgumentException(SR.SNAPSHOT_QUERY_OPTION_ALREADY_DEFINED);
        }
        else {
            this.snapshotID = snapshotID;
        }
    }
}
 

/**
 * Get the service client address from a complete Uri.
 * 
 * @param address
 *            Complete address of the resource.
 * @param usePathStyleUris
 *            a value indicating if the address is a path style uri.
 * @return the service client address from a complete Uri.
 * @throws URISyntaxException
 */
public static StorageUri getServiceClientBaseAddress(final StorageUri addressUri, final boolean usePathStyleUris)
        throws URISyntaxException {
    return new StorageUri(new URI(getServiceClientBaseAddress(addressUri.getPrimaryUri(), usePathStyleUris)),
            addressUri.getSecondaryUri() != null ?
            new URI(getServiceClientBaseAddress(addressUri.getSecondaryUri(), usePathStyleUris)) : null);
}
 

/**
 * Creates an instance of the <code>CloudFileDirectory</code> class using the specified address, share,
 * and client.
 * 
 * @param uri
 *            A {@link StorageUri} that represents the file directory's address.
 * @param directoryName
 *            A <code>String</code> that represents the name of the directory.
 * @param share
 *            A {@link CloudFileShare} object that represents the associated file share.
 */
protected CloudFileDirectory(final StorageUri uri, final String directoryName, final CloudFileShare share) {
    Utility.assertNotNull("uri", uri);
    Utility.assertNotNull("directoryName", directoryName);
    Utility.assertNotNull("share", share);

    this.name = directoryName;
    this.fileServiceClient = share.getServiceClient();
    this.share = share;
    this.storageUri = uri;
}
 

/**
 * Returns a reference to a {@link CloudFileDirectory} object that represents a directory in this directory.
 * 
 * @param itemName
 *            A <code>String</code> that represents the name of the directory.
 * 
 * @return A {@link CloudFileDirectory} object that represents a reference to the specified directory.
 * 
 * @throws URISyntaxException
 *             If the resource URI is invalid.
 * @throws StorageException
 */
public CloudFileDirectory getDirectoryReference(final String itemName) throws URISyntaxException,
        StorageException {
    Utility.assertNotNullOrEmpty("itemName", itemName);

    StorageUri subdirectoryUri = PathUtility.appendPathToUri(this.storageUri, itemName);
    return new CloudFileDirectory(subdirectoryUri, itemName, this.getShare());
}
 

/**
 * Returns the list of URIs for all storage locations of the blob item.
 * 
 * @return A <code>{@link StorageUri}</code> object which represents the blob item's URI.
 */
StorageUri getStorageUri();
 

/**
 * Appends a path to a list of URIs correctly using "/" as separator.
 * 
 * @param uriList
 *            The base Uri.
 * @param relativeOrAbslouteUri
 *            The relative or absloute URI.
 * @return The appended Uri.
 * @throws URISyntaxException
 */
public static StorageUri appendPathToUri(final StorageUri uriList, final String relativeOrAbsoluteUri,
        final String separator) throws URISyntaxException {
    return new StorageUri(appendPathToSingleUri(uriList.getPrimaryUri(), relativeOrAbsoluteUri, separator),
            appendPathToSingleUri(uriList.getSecondaryUri(), relativeOrAbsoluteUri, separator));
}
 

/**
 * Sets the list of URIs for all locations.
 * 
 * @param storageUri
 *            A {@link StorageUri} object which represents the list of URIs for all locations.
 */
protected void setStorageUri(final StorageUri storageUri) {
    this.storageUri = storageUri;
}
 

/**
 * Sets the list of URIs for all locations for the blob.
 * 
 * @param storageUri
 *            The list of URIs for all locations for the blob.
 */
protected void setStorageUri(final StorageUri storageUri) {
    this.storageUri = storageUri;
}
 

/**
 * Sets the list of URIs for all locations.
 *
 * @param storageUri
 *            A {@link StorageUri} that represents the list of URIs for all locations.
 */
protected void setStorageUri(final StorageUri storageUri) {
    this.storageUri = storageUri;
}