Package com.inductiveautomation.ignition.common.project

Class EffectiveProjectResource

java.lang.Object

com.inductiveautomation.ignition.common.project.EffectiveProjectResource

All Implemented Interfaces:

ProjectResource, Serializable

public class EffectiveProjectResource
extends Object
implements ProjectResource

Delegate project resource implementation that overrides the projectName, so that all project resources, inherited or otherwise, share the same resource id.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.common.project.resource.ProjectResource

DEFAULT_DATA_KEY, LEGACY_FOLDER_RESOURCE_TYPE, PLATFORM_MODULE_ID

Constructor Summary

Constructors

Constructor	Description
EffectiveProjectResource(String projectName, ProjectResource delegateResource)

Method Summary

Modifier and Type	Method	Description
int	getApplicationScope()	Get the application scope of this resource.
Map<String,com.inductiveautomation.ignition.common.gson.JsonElement>	getAttributes()	Get an immutable view of the attributes map.
byte[]	getContentDigest()	Get the SHA-256 digest of the content of this resource.
byte[]	getData()
byte[]	getData(String key)
com.google.common.collect.ImmutableSet<String>	getDataKeys()	Get an immutable view of the data key set.
String	getDocumentation()
String	getProjectName()	Get the name of the Project this resource belongs to.
ProjectResourceId	getResourceId()
String	getResourceName()
ResourcePath	getResourcePath()
ResourceSignature	getResourceSignature()	Get the ResourceSignature for this resource.
ResourceType	getResourceType()
int	getVersion()	Get the version of this resource.
boolean	isFolder()
boolean	isLocked()
boolean	isOverridable()
boolean	isRestricted()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.common.project.resource.ProjectResource

copy, copy, getAttribute, getFolderPath, isModuleFolder, isResourceTypeFolder, isSingletonResource, toBuilder

Constructor Details

EffectiveProjectResource

public EffectiveProjectResource(String projectName,
 ProjectResource delegateResource)

Method Details

getProjectName

public String getProjectName()

Description copied from interface: ProjectResource

Get the name of the Project this resource belongs to.

Specified by:

getProjectName in interface ProjectResource

Returns:

the name of the Project this resource belongs to.

getResourceId

public ProjectResourceId getResourceId()

Specified by:

getResourceId in interface ProjectResource

getContentDigest

public byte[] getContentDigest()

Description copied from interface: ProjectResource

Get the SHA-256 digest of the content of this resource. This does not include the project name or any part of the path to this resource, but rather, it's a representation of the contents of the folder on disk.

Any changes to any of the resource contents of that folder shall result in a change to the content digest.

Specified by:

getContentDigest in interface ProjectResource

Returns:

the SHA-256 digest of the content of this resource.

See Also:

• ProjectResource.getResourceSignature()
• ResourceSignature

getResourceSignature

public ResourceSignature getResourceSignature()

Description copied from interface: ProjectResource

Get the ResourceSignature for this resource.

Specified by:

getResourceSignature in interface ProjectResource

Returns:

the ResourceSignature for this resource.

getResourceName

public String getResourceName()

Specified by:

getResourceName in interface ProjectResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in interface ProjectResource

getResourcePath

public ResourcePath getResourcePath()

Specified by:

getResourcePath in interface ProjectResource

getDocumentation

@Nullable
public String getDocumentation()

Specified by:

getDocumentation in interface ProjectResource

getApplicationScope

public int getApplicationScope()

Description copied from interface: ProjectResource

Get the application scope of this resource.

Specified by:

getApplicationScope in interface ProjectResource

Returns:

the application scope of this resource.

See Also:

• ApplicationScope

getVersion

public int getVersion()

Description copied from interface: ProjectResource

Get the version of this resource.

The version number is not intended to track mutations to the resource like the legacy edit count, but rather, its interpretation and use is for the entities this resource type belongs to and so it can be used to reason about the contents of the resource, e.g. to distinguish between serialization formats.

Specified by:

getVersion in interface ProjectResource

Returns:

the version of this resource.

isFolder

public boolean isFolder()

Specified by:

isFolder in interface ProjectResource

Returns:

true if this resource is a folder.

isLocked

public boolean isLocked()

Specified by:

isLocked in interface ProjectResource

Returns:

true if this resource is OEM locked.

isRestricted

public boolean isRestricted()

Specified by:

isRestricted in interface ProjectResource

Returns:

true if this resource is restricted to users of a certain role. Formerly known as "protected".

isOverridable

public boolean isOverridable()

Specified by:

isOverridable in interface ProjectResource

Returns:

true if this resource can be overridden by child projects.

getData

@Nullable
public byte[] getData()

Specified by:

getData in interface ProjectResource

getData

@Nullable
public byte[] getData(String key)

Specified by:

getData in interface ProjectResource

getDataKeys

@Nonnull
public com.google.common.collect.ImmutableSet<String> getDataKeys()

Description copied from interface: ProjectResource

Get an immutable view of the data key set.

Specified by:

getDataKeys in interface ProjectResource

Returns:

an immutable view of the data key set.

getAttributes

@Nonnull
public Map<String,com.inductiveautomation.ignition.common.gson.JsonElement> getAttributes()

Description copied from interface: ProjectResource

Get an immutable view of the attributes map.

Specified by:

getAttributes in interface ProjectResource

Returns:

an immutable view of the attributes map.