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

Class AbstractAzResource<T extends AbstractAzResource<T,P,R>,P extends AbstractAzResource<P,?,?>,R>

java.lang.Object

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

All Implemented Interfaces:

AzResource<T,P,R>, AzResourceBase, Refreshable

Direct Known Subclasses:

AbstractAzServiceSubscription, AzResource.None, GenericResource, ResourceDeployment, ResourceGroup

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

Nested Class Summary

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

AzResource.Draft<T extends AzResource<T,?,R>,R>, AzResource.None, AzResource.Status

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

AzResourceBase.FormalStatus

Field Summary

Fields

Modifier and Type	Field	Description
private Debouncer	fireEvents
private Lock	lock
private AbstractAzResourceModule<T,P,R>	module
private String	name
private AtomicReference<R>	remoteRef
private String	resourceGroupName
private AtomicReference<String>	statusRef
private AtomicLong	syncTimeRef

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

CACHE_LIFETIME, NONE, RESOURCE_GROUP_PLACEHOLDER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAzResource(AbstractAzResource<T,P,R> origin)	copy constructor
protected	AbstractAzResource(String name, AbstractAzResourceModule<T,P,R> module)	constructor for non-top resource only.
protected	AbstractAzResource(String name, String resourceGroupName, AbstractAzResourceModule<T,P,R> module)

Method Summary

Modifier and Type	Method	Description
private <D> D	cast(Object origin)
void	delete()
private void	deleteFromAzure()
void	deleteFromCache()
protected void	doModify(Runnable body, String status)
R	doModify(Callable<R> body, String status)
boolean	exists()
private void	fireStatusChangedEvent()
String	getId()
R	getRemote(boolean... sync)
private R	getRemoteInner()
ResourceGroup	getResourceGroup()
String	getStatus()
AbstractAzResourceModule<?,T,?>	getSubModule(String moduleName)
abstract List<AbstractAzResourceModule<?,T,?>>	getSubModules()
void	invalidateCache()
boolean	isDraft()
boolean	isDraftForCreating()
boolean	isDraftForUpdating()
protected R	loadRemote()
abstract String	loadStatus(R remote)
void	refresh()
private R	refreshRemote(R remote)
protected R	refreshRemoteFromAzure(R remote)
private void	reloadRemote()
protected Optional<R>	remoteOptional(boolean... sync)
(package private) void	setRemote(R newRemote)
void	setStatus(String status)
AzResource.Draft<T,R>	update()
protected void	updateAdditionalProperties(R newRemote, R oldRemote)

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.AzResource

getFullResourceType, getModule, getName, getParent, getPortalUrl, getResourceGroupName, getResourceTypeName, getSubscription, getSubscriptionId, id, name

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

getFormalStatus

Field Detail

name

@Nonnull
private final String name

resourceGroupName

@Nonnull
private final String resourceGroupName

module

@Nonnull
private final AbstractAzResourceModule<T extends AbstractAzResource<T,P,R>,P extends AbstractAzResource<P,?,?>,R> module

syncTimeRef

@Nonnull
private final AtomicLong syncTimeRef

remoteRef

@Nonnull
private final AtomicReference<R> remoteRef

statusRef

@Nonnull
private final AtomicReference<String> statusRef

fireEvents

@Nonnull
private final Debouncer fireEvents

lock

private final Lock lock

Constructor Detail

AbstractAzResource

protected AbstractAzResource(@Nonnull
                             String name,
                             @Nonnull
                             String resourceGroupName,
                             @Nonnull
                             AbstractAzResourceModule<T,P,R> module)

AbstractAzResource

protected AbstractAzResource(@Nonnull
                             String name,
                             @Nonnull
                             AbstractAzResourceModule<T,P,R> module)

constructor for non-top resource only. module.getParent().getResourceGroupName() is only reliable if current resource is not root of resource hierarchy tree.

AbstractAzResource

protected AbstractAzResource(@Nonnull
                             AbstractAzResource<T,P,R> origin)

copy constructor

Method Detail

exists

public boolean exists()

Specified by:

exists in interface AzResource<T extends AbstractAzResource<T,P,R>,P extends AbstractAzResource<P,?,?>,R>

Specified by:

exists in interface AzResourceBase

refresh

public void refresh()

Specified by:

refresh in interface AzResource<T extends AbstractAzResource<T,P,R>,P extends AbstractAzResource<P,?,?>,R>

Specified by:

refresh in interface Refreshable

invalidateCache

public void invalidateCache()

getRemote

@Nullable
public final R getRemote(boolean... sync)

getRemoteInner

private R getRemoteInner()

reloadRemote

private void reloadRemote()

setRemote

void setRemote(@Nullable
               R newRemote)

updateAdditionalProperties

protected void updateAdditionalProperties(@Nullable
                                          R newRemote,
                                          @Nullable
                                          R oldRemote)

loadRemote

@Nullable
protected final R loadRemote()

refreshRemote

@Nullable
private R refreshRemote(@Nonnull
                        R remote)

Returns:

null if resource has been deleted.

refreshRemoteFromAzure

@Nullable
protected R refreshRemoteFromAzure(@Nonnull
                                   R remote)

Returns:

null if resource has been deleted.

update

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

Specified by:

update in interface AzResource<T extends AbstractAzResource<T,P,R>,P extends AbstractAzResource<P,?,?>,R>

delete

public void delete()

Specified by:

delete in interface AzResource<T extends AbstractAzResource<T,P,R>,P extends AbstractAzResource<P,?,?>,R>

deleteFromAzure

private void deleteFromAzure()

deleteFromCache

public void deleteFromCache()

setStatus

public void setStatus(@Nonnull
                      String status)

getStatus

@Nonnull
public String getStatus()

Specified by:

getStatus in interface AzResource<T extends AbstractAzResource<T,P,R>,P extends AbstractAzResource<P,?,?>,R>

Specified by:

getStatus in interface AzResourceBase

doModify

protected void doModify(@Nonnull
                        Runnable body,
                        @Nullable
                        String status)

doModify

@Nullable
public R doModify(@Nonnull
                  Callable<R> body,
                  @Nullable
                  String status)

fireStatusChangedEvent

private void fireStatusChangedEvent()

getId

@Nonnull
public String getId()

Specified by:

getId in interface AzResource<T extends AbstractAzResource<T,P,R>,P extends AbstractAzResource<P,?,?>,R>

Specified by:

getId in interface AzResourceBase

getSubModules

@Nonnull
public abstract List<AbstractAzResourceModule<?,T,?>> getSubModules()

loadStatus

@Nonnull
public abstract String loadStatus(@Nonnull
                                  R remote)

remoteOptional

@Nonnull
protected Optional<R> remoteOptional(boolean... sync)

cast

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

getSubModule

@Nullable
public AbstractAzResourceModule<?,T,?> getSubModule(String moduleName)

getResourceGroup

@Nullable
public ResourceGroup getResourceGroup()

isDraft

public boolean isDraft()

isDraftForCreating

public boolean isDraftForCreating()

isDraftForUpdating

public boolean isDraftForUpdating()