Package com.microsoft.azure.toolkit.lib.common.model

Class AbstractAzResourceModule<T extends AbstractAzResource<T,P,R>,P extends AzResource,R>

java.lang.Object

com.microsoft.azure.toolkit.lib.common.model.AbstractAzResourceModule<T,P,R>

All Implemented Interfaces:

AzComponent, AzResourceModule<T>, Refreshable

Direct Known Subclasses:

AbstractAzService, AbstractEmulatableAzResourceModule, AzResourceModule.None, GenericResourceModule, ResourceDeploymentModule, ResourceGroupModule

public abstract class AbstractAzResourceModule<T extends AbstractAzResource<T,P,R>,P extends AzResource,R>
extends Object
implements AzResourceModule<T>

Nested Class Summary

Nested classes/interfaces inherited from interface com.microsoft.azure.toolkit.lib.common.model.AzResourceModule

AzResourceModule.None

Field Summary

Fields

Modifier and Type	Field	Description
private Debouncer	fireEvents
private Lock	lock
private String	name
private Iterator<? extends com.azure.core.util.paging.ContinuablePage<String,R>>	pages
protected P	parent
protected Map<String,Optional<T>>	resources
protected AtomicLong	syncTimeRef
private Map<String,T>	tempResources

Fields inherited from interface com.microsoft.azure.toolkit.lib.common.model.AzResourceModule

NONE

Constructor Summary

Constructors

Constructor	Description
AbstractAzResourceModule()

Method Summary

Modifier and Type	Method	Description
protected void	addResources(Map<String,R> loadedResources)
protected void	addResourceToLocal(String id, T resource, boolean... silent)
protected void	addResourceToLocalResourceGroup(String id, T resource, boolean... silent)
protected <D> D	cast(Object origin)
void	clear()
T	create(AzResource.Draft<T,?> d)
<D extends AzResource.Draft<T,R>> D	create(String name, String rgName)
void	delete(String name, String rgName)
protected void	deleteResourceFromAzure(String resourceId)
protected void	deleteResourceFromLocal(String id, boolean... silent)
protected void	deleteResourceFromLocalResourceGroup(T resource, boolean... silent)
boolean	exists(String name, String rgName)
private void	fireChildrenChangedEvent()
T	get(String resourceId)
T	get(String name, String rgName)
protected Object	getClient()	get track2 client, which is used to implement loadResourcePagesFromAzure(), loadResourceFromAzure(java.lang.String, java.lang.String) and deleteResourceFromAzure(java.lang.String)
String	getFullResourceType()
String	getId()
T	getOrDraft(String name, String rgName)
T	getOrInit(String name, String rgName)
T	getOrTemp(String name, String rgName)
static int	getPageSize()
protected Map<String,R>	getResourcesFromAzure()
String	getResourceTypeName()
String	getServiceNameForTelemetry()
String	getSubscriptionId()
boolean	hasMoreResources()
protected void	invalidateCache()
protected boolean	isAuthRequiredForListing()
protected boolean	isAuthRequiredForResource(String resourceId)
List<T>	list()
List<T>	listByResourceGroup(String resourceGroup)
List<T>	listCachedResources()
void	loadMoreResources()
protected R	loadResourceFromAzure(String name, String resourceGroup)
protected Iterator<? extends com.azure.core.util.paging.ContinuablePage<String,R>>	loadResourcePagesFromAzure()
protected AzResource.Draft<T,R>	newDraftForCreate(String name, String rgName)
protected AzResource.Draft<T,R>	newDraftForUpdate(T t)
protected abstract T	newResource(String name, String resourceGroupName)
protected abstract T	newResource(R r)
private String	normalizeResourceGroupName(String name, String rgName)
void	refresh()
private void	reloadResources()
private void	setResources(Map<String,R> loadedResources)
private void	telemeterResourceCount(Map<String,R> loadedResources)
String	toResourceId(String resourceName, String resourceGroup)
T	update(AzResource.Draft<T,?> draft)
(package private) <D extends AzResource.Draft<T,R>> D	update(T resource)
<D extends AzResource.Draft<T,R>> D	updateOrCreate(String name, String rgName)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microsoft.azure.toolkit.lib.common.model.AzComponent

getName

Field Detail

name

@Nonnull
private final String name

parent

protected final P extends AzResource parent

syncTimeRef

@Nonnull
protected final AtomicLong syncTimeRef

resources

@Nonnull
protected final Map<String,Optional<T extends AbstractAzResource<T,P,R>>> resources

tempResources

private final Map<String,T extends AbstractAzResource<T,P,R>> tempResources

fireEvents

@Nonnull
private final Debouncer fireEvents

lock

private final Lock lock

pages

private Iterator<? extends com.azure.core.util.paging.ContinuablePage<String,R>> pages

Constructor Detail

AbstractAzResourceModule

public AbstractAzResourceModule()

Method Detail

refresh

public void refresh()

Specified by:

refresh in interface AzResourceModule<T extends AbstractAzResource<T,P,R>>

Specified by:

refresh in interface Refreshable

invalidateCache

protected void invalidateCache()

list

@Nonnull
public List<T> list()

Specified by:

list in interface AzResourceModule<T extends AbstractAzResource<T,P,R>>

reloadResources

private void reloadResources()

telemeterResourceCount

private void telemeterResourceCount(Map<String,R> loadedResources)

getResourcesFromAzure

protected Map<String,R> getResourcesFromAzure()

loadMoreResources

public void loadMoreResources()

hasMoreResources

public boolean hasMoreResources()

setResources

private void setResources(Map<String,R> loadedResources)

addResources

protected void addResources(Map<String,R> loadedResources)

clear

public void clear()

get

@Nullable
public T get(@Nonnull
             String name,
             @Nullable
             String rgName)

Specified by:

get in interface AzResourceModule<T extends AbstractAzResource<T,P,R>>

get

@Nullable
public T get(@Nonnull
             String resourceId)

Specified by:

get in interface AzResourceModule<T extends AbstractAzResource<T,P,R>>

exists

public boolean exists(@Nonnull
                      String name,
                      @Nullable
                      String rgName)

Specified by:

exists in interface AzResourceModule<T extends AbstractAzResource<T,P,R>>

delete

public void delete(@Nonnull
                   String name,
                   @Nullable
                   String rgName)

Specified by:

delete in interface AzResourceModule<T extends AbstractAzResource<T,P,R>>

getOrDraft

@Nonnull
public T getOrDraft(@Nonnull
                    String name,
                    @Nullable
                    String rgName)

Specified by:

getOrDraft in interface AzResourceModule<T extends AbstractAzResource<T,P,R>>

getOrTemp

@Nonnull
public T getOrTemp(@Nonnull
                   String name,
                   @Nullable
                   String rgName)

getOrInit

@Nonnull
public T getOrInit(@Nonnull
                   String name,
                   @Nullable
                   String rgName)

listCachedResources

@Nonnull
public List<T> listCachedResources()

listByResourceGroup

@Nonnull
public List<T> listByResourceGroup(@Nonnull
                                   String resourceGroup)

updateOrCreate

@Nonnull
public <D extends AzResource.Draft<T,R>> D updateOrCreate(@Nonnull
                                                                String name,
                                                                @Nullable
                                                                String rgName)

create

@Nonnull
public <D extends AzResource.Draft<T,R>> D create(@Nonnull
                                                        String name,
                                                        @Nullable
                                                        String rgName)

create

@Nonnull
public T create(@Nonnull
                AzResource.Draft<T,?> d)

Specified by:

create in interface AzResourceModule<T extends AbstractAzResource<T,P,R>>

update

@Nonnull
<D extends AzResource.Draft<T,R>> D update(@Nonnull
                                                 T resource)

update

@Nonnull
public T update(@Nonnull
                AzResource.Draft<T,?> draft)

Specified by:

update in interface AzResourceModule<T extends AbstractAzResource<T,P,R>>

toResourceId

@Nonnull
public String toResourceId(@Nonnull
                           String resourceName,
                           @Nullable
                           String resourceGroup)

deleteResourceFromLocal

protected void deleteResourceFromLocal(@Nonnull
                                       String id,
                                       boolean... silent)

deleteResourceFromLocalResourceGroup

protected void deleteResourceFromLocalResourceGroup(@Nonnull
                                                    T resource,
                                                    boolean... silent)

addResourceToLocal

protected void addResourceToLocal(@Nonnull
                                  String id,
                                  @Nullable
                                  T resource,
                                  boolean... silent)

addResourceToLocalResourceGroup

protected void addResourceToLocalResourceGroup(@Nonnull
                                               String id,
                                               @Nonnull
                                               T resource,
                                               boolean... silent)

fireChildrenChangedEvent

private void fireChildrenChangedEvent()

loadResourcePagesFromAzure

@Nonnull
protected Iterator<? extends com.azure.core.util.paging.ContinuablePage<String,R>> loadResourcePagesFromAzure()

loadResourceFromAzure

@Nullable
protected R loadResourceFromAzure(@Nonnull
                                  String name,
                                  @Nullable
                                  String resourceGroup)

deleteResourceFromAzure

protected void deleteResourceFromAzure(@Nonnull
                                       String resourceId)

normalizeResourceGroupName

private String normalizeResourceGroupName(String name,
                                          @Nullable
                                          String rgName)

newDraftForCreate

@Nonnull
protected AzResource.Draft<T,R> newDraftForCreate(@Nonnull
                                                        String name,
                                                        @Nullable
                                                        String rgName)

newDraftForUpdate

@Nonnull
protected AzResource.Draft<T,R> newDraftForUpdate(@Nonnull
                                                        T t)

newResource

@Nonnull
protected abstract T newResource(@Nonnull
                                 R r)

newResource

@Nonnull
protected abstract T newResource(@Nonnull
                                 String name,
                                 @Nullable
                                 String resourceGroupName)

getClient

@Nullable
protected Object getClient()

get track2 client, which is used to implement loadResourcePagesFromAzure(), loadResourceFromAzure(java.lang.String, java.lang.String) and deleteResourceFromAzure(java.lang.String)

getFullResourceType

@Nonnull
public String getFullResourceType()

Specified by:

getFullResourceType in interface AzComponent

Specified by:

getFullResourceType in interface AzResourceModule<T extends AbstractAzResource<T,P,R>>

getResourceTypeName

@Nonnull
public String getResourceTypeName()

Specified by:

getResourceTypeName in interface AzComponent

Specified by:

getResourceTypeName in interface AzResourceModule<T extends AbstractAzResource<T,P,R>>

getSubscriptionId

@Nonnull
public String getSubscriptionId()

Specified by:

getSubscriptionId in interface AzResourceModule<T extends AbstractAzResource<T,P,R>>

getId

@Nonnull
public String getId()

Specified by:

getId in interface AzComponent

cast

@Nonnull
protected <D> D cast(@Nonnull
                     Object origin)

getPageSize

public static int getPageSize()

isAuthRequiredForListing

protected boolean isAuthRequiredForListing()

isAuthRequiredForResource

protected boolean isAuthRequiredForResource(@Nonnull
                                            String resourceId)

getServiceNameForTelemetry

public String getServiceNameForTelemetry()

Specified by:

getServiceNameForTelemetry in interface AzResourceModule<T extends AbstractAzResource<T,P,R>>