Class AzureStorageBlobProtocolResolver

java.lang.Object

com.azure.spring.cloud.core.resource.AbstractAzureStorageProtocolResolver

com.azure.spring.cloud.core.resource.AzureStorageBlobProtocolResolver

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.config.BeanFactoryPostProcessor, org.springframework.context.ResourceLoaderAware, org.springframework.core.io.ProtocolResolver, org.springframework.core.io.ResourceLoader, org.springframework.core.io.support.ResourcePatternResolver

public final class AzureStorageBlobProtocolResolver
extends AbstractAzureStorageProtocolResolver

A ProtocolResolver implementation for the azure-blob:// protocol.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractAzureStorageProtocolResolver

AbstractAzureStorageProtocolResolver.StorageContainerClient, AbstractAzureStorageProtocolResolver.StorageContainerItem, AbstractAzureStorageProtocolResolver.StorageItem

Field Summary

Fields inherited from class AbstractAzureStorageProtocolResolver

beanFactory, matcher

Fields inherited from interface org.springframework.core.io.ResourceLoader

CLASSPATH_URL_PREFIX

Fields inherited from interface org.springframework.core.io.support.ResourcePatternResolver

CLASSPATH_ALL_URL_PREFIX

Constructor Summary

Constructors

Constructor	Description
AzureStorageBlobProtocolResolver()	Creates an instance of AzureStorageBlobProtocolResolver.

Method Summary

Modifier and Type	Method	Description
protected AbstractAzureStorageProtocolResolver.StorageContainerClient	getStorageContainerClient(String name)	Get StorageContainerClient with specified container name.
protected org.springframework.core.io.Resource	getStorageResource(String location, Boolean autoCreate)	Get Resource from resource location.
protected StorageType	getStorageType()	The storageType of current protocolResolver.
protected Stream<AbstractAzureStorageProtocolResolver.StorageContainerItem>	listStorageContainers(String containerPrefix)	List all storage containers.

Methods inherited from class AbstractAzureStorageProtocolResolver

getClassLoader, getMatchedContainers, getMatchedItems, getResource, getResources, postProcessBeanFactory, resolve, resolveResources, setResourceLoader

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AzureStorageBlobProtocolResolver

public AzureStorageBlobProtocolResolver()

Creates an instance of AzureStorageBlobProtocolResolver.

Method Details

getStorageType

protected StorageType getStorageType()

The storageType of current protocolResolver.

Specified by:

getStorageType in class AbstractAzureStorageProtocolResolver

Returns:

StorageType.BLOB;

listStorageContainers

protected Stream<AbstractAzureStorageProtocolResolver.StorageContainerItem> listStorageContainers(String containerPrefix)

Description copied from class: AbstractAzureStorageProtocolResolver

List all storage containers.

The underlying storage system may support 'prefix' filter, for example, Azure Storage Blob supports this

https://docs.microsoft.com/rest/api/storageservices/list-blobs

In this case, we can avoid load all containers to do client side filtering.

Specified by:

listStorageContainers in class AbstractAzureStorageProtocolResolver

Parameters:

containerPrefix - container name prefix, without any wildcard characters.

Returns:

All storage containers match the given prefix, or all containers if the underlying storage system doesn't support prefix match.

getStorageContainerClient

protected AbstractAzureStorageProtocolResolver.StorageContainerClient getStorageContainerClient(String name)

Description copied from class: AbstractAzureStorageProtocolResolver

Get StorageContainerClient with specified container name.

Specified by:

getStorageContainerClient in class AbstractAzureStorageProtocolResolver

Parameters:

name - Container name

Returns:

the storage container client.

getStorageResource

protected org.springframework.core.io.Resource getStorageResource(String location,
 Boolean autoCreate)

Description copied from class: AbstractAzureStorageProtocolResolver

Get Resource from resource location.

Specified by:

getStorageResource in class AbstractAzureStorageProtocolResolver

Parameters:

location - The specified resource location.

autoCreate - Whether to auto-create the resource if the resource is not exist.

Returns:

the storage Resource.