Package com.thingworx.ux.media

Class MediaEntity

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.entities.ServiceProviderEntity

com.thingworx.ux.media.MediaEntity

All Implemented Interfaces:

ISupportsAccessModifier, IConfigurableObject, INotScriptFriendly, ISupportsDeprecation, IDiffableObject, IAvatar, IEntityLifeCycleEvent, IPersistable, IServiceProvider, ITaggableObject, IDependencyScannableObject, IEntityDefinition, IPersistableObject<String>, IDesignTimeSecurable, IDesignTimeSecurableEntity, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, ISSOResourceProvider, IAspectContainer, INamedObject, Serializable

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public class MediaEntity
extends ServiceProviderEntity
implements ISSOResourceProvider, ISupportsAccessModifier

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHENTICATION_TYPE
static final String	AUTHENTICATION_TYPE_BASIC
static final String	AUTHENTICATION_TYPE_NONE
static final String	AUTHENTICATION_TYPE_OAUTH_M2M
static final String	AUTHENTICATION_TYPE_SESSION_USER
static final String	AUTHENTICATION_TYPE_SSO
static final String	AUTHORIZATION_SERVER_ID
static final String	CACHE_HEADER_NAME
static final String	CONFIG_TABLE_CONTENT_SOURCE_CONNECTION_INFO
static final String	CONFIGURATION_SCOPE_TABLE_NAME
static final String	DYNAMIC_CONTENT
static final String	FLOW_CONNECTION_NAME
static final String	FLOW_CONNECTOR_CONFIGURATION
static final String	IGNORE_SSL_ERRORS
static org.slf4j.Logger	logger
static final String	NO_CACHE_HEADER_CHECKBOX
static final String	NO_CACHE_HEADER_VALUE
static final String	PASSWORD
static final String	POST_PROXY_HEADERS_TO_FORWARD
static final String	SCOPE
static final String	SESSION_USER_CONFIGURATION_TABLE
static final String	SESSION_USER_QUERY_PARAMETER
static final String	SSL_CONFIG_TABLE
static final String	SSL_KEYSTORE_PASSWORD
static final String	SSL_KEYSTORE_PATH
static final String	SSL_TRUSTSTORE_PASSWORD
static final String	SSL_TRUSTSTORE_PATH
static final String	TEST_URL
static final String	TIMEOUT
static final String	URL
static final String	USER_ID

Fields inherited from class com.thingworx.entities.RootEntity

BASIC_PROPERTY_DEFINITIONS, EXCLUDED_ENTITY_TYPES_IN_PROJECT

Fields inherited from class com.thingworx.types.NamedObject

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
MediaEntity()

Method Summary

Modifier and Type	Method	Description
static MediaEntity	fromJSON(org.json.JSONObject jsonObject)	Deprecated.
RelationshipTypes.ThingworxRelationshipTypes	getEntityType()
ImagePrimitive	getImage()
byte[]	GetImage()	Service Category: Images Service Description: Get the content as an image.
String	GetMimeType()	Service Category: Images Service Description: Get the mime type.
String	GetProxyUrl(String targetUrl, Boolean isAbsoluteTargetUrl)	Deprecated. As of release 8.5.0, replaced by GetProxyUrl(String, Boolean, Boolean)
String	GetProxyUrl(String targetUrl, Boolean isAbsoluteTargetUrl, Boolean clientFollowsRedirect)	Service Category: Images Service Description: Get a URL to proxy content relative to the configured origin server.

Methods inherited from class com.thingworx.entities.ServiceProviderEntity

getInstancePublicServiceDefinitions, getInstanceServiceDefinition, getInstanceServiceDefinitions, initializeEntity, preInitializeEntity, processAPIServiceRequest, processServiceRequest

Methods inherited from class com.thingworx.entities.RootEntity

AddConfigurationTableDefinition, AddConfigurationTableDefinition, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, AddTags, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, DeleteConfigurationTableRows, DeleteConfigurationTableRows, deleteDesignTimePermission, DeleteDesignTimePermission, deleteRunTimePermission, DeleteRunTimePermission, deleteVisibilityPermission, DeleteVisibilityPermission, dispose, getAspects, GetAvatar, getAvatarContent, GetAvatarURL, GetConfigurationChangeHistory, getConfigurationSetting, getConfigurationTable, GetConfigurationTable, GetConfigurationTableDefinition, GetConfigurationTableRow, GetConfigurationTables, GetDescription, getDesignTimePermissions, GetDesignTimePermissions, GetDesignTimePermissionsAsJSON, getDocumentationContent, getEntityTypeAsString, GetEventDefinition, GetEventDefinitions, GetHomeMashup, GetIncomingDependencies, GetIncomingDependenciesAsNetwork, GetInstanceMetadataAsJSON, GetInstanceMetadataWithPermissionsAsJSON, GetLastModifiedDate, GetMetadata, GetMetadataAsJSON, GetMetadataWithPermissionsAsJSON, GetOutgoingDependencies, GetOutgoingDependenciesAsNetwork, getOwner, GetOwner, GetPermissionsForCurrentUser, GetPermissionsForGroup, GetPermissionsForUser, GetProjectName, GetPropertyDefinition, GetPropertyDefinitions, getRunTimePermissions, GetRunTimePermissions, GetRunTimePermissionsAsJSON, GetServiceDefinition, GetServiceDefinitions, getStringConfigurationSetting, getStringConfigurationSettingWithDefault, GetSummaryInformation, getTags, GetTags, GetTagsAsInfoTable, getVisibilityPermissions, GetVisibilityPermissions, GetVisibilityPermissionsAsJSON, HasIncomingDependencies, HasOutgoingDependencies, isEditable, isEditableExtensionObject, isEditableSystemObject, isExtensionObject, IsMultiRowTable, isOwner, isSystemObject, isThemeObject, isVisible, isVisible, ListDeprecatedUsage, persistDesignTimePermissions, persistRunTimePermissions, persistVisibilityPermissions, RemoveTags, SaveConfigurationTables, SetAvatar, setConfigurationSetting, SetConfigurationTable, SetConfigurationTableRows, SetDescription, setDesignTimePermissions, SetDesignTimePermissionsAsJSON, setDocumentationContent, setExtensionObject, SetHomeMashup, setLastModifiedDate, SetMultiRowConfigurationTable, setOwner, SetOwner, SetProjectName, setRunTimePermissions, SetRunTimePermissionsAsJSON, setStringConfigurationSetting, SetTags, setVisibilityPermissions, SetVisibilityPermissionsAsJSON, toJSON, toJSONDefinition, UpdateProjectDependencies, validateConfiguration

Methods inherited from class com.thingworx.persistence.common.PersistableNamedObject

getID, hasID, isTransient

Methods inherited from class com.thingworx.types.NamedObject

getDescription, getName, setDescription, setName, toValueCollection

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.thingworx.types.INamedObject

getDescription, getName

Methods inherited from interface com.thingworx.entities.interfaces.IPersistable

getID, hasID

Methods inherited from interface com.thingworx.security.permissions.ISecurable

getID, getName

Methods inherited from interface com.thingworx.accesscontrol.ISupportsAccessModifier

getAccessModifier, getAccessModifierScope, getExemptList, hasAccessModifier, isInternalAccess, isPrivateAccess, isRestrictedAccess

Methods inherited from interface com.thingworx.deprecation.ISupportsDeprecation

getDeprecated, isDeprecated, isDeprecatedBefore, since

Field Details

logger

public static org.slf4j.Logger logger

CONFIG_TABLE_CONTENT_SOURCE_CONNECTION_INFO

public static final String CONFIG_TABLE_CONTENT_SOURCE_CONNECTION_INFO

See Also:

• Constant Field Values

DYNAMIC_CONTENT

public static final String DYNAMIC_CONTENT

See Also:

• Constant Field Values

URL

public static final String URL

See Also:

• Constant Field Values

TEST_URL

public static final String TEST_URL

See Also:

• Constant Field Values

NO_CACHE_HEADER_CHECKBOX

public static final String NO_CACHE_HEADER_CHECKBOX

See Also:

• Constant Field Values

CACHE_HEADER_NAME

public static final String CACHE_HEADER_NAME

See Also:

• Constant Field Values

NO_CACHE_HEADER_VALUE

public static final String NO_CACHE_HEADER_VALUE

See Also:

• Constant Field Values

IGNORE_SSL_ERRORS

public static final String IGNORE_SSL_ERRORS

See Also:

• Constant Field Values

SSL_CONFIG_TABLE

public static final String SSL_CONFIG_TABLE

See Also:

• Constant Field Values

SSL_KEYSTORE_PATH

public static final String SSL_KEYSTORE_PATH

See Also:

• Constant Field Values

SSL_KEYSTORE_PASSWORD

public static final String SSL_KEYSTORE_PASSWORD

See Also:

• Constant Field Values

SSL_TRUSTSTORE_PATH

public static final String SSL_TRUSTSTORE_PATH

See Also:

• Constant Field Values

SSL_TRUSTSTORE_PASSWORD

public static final String SSL_TRUSTSTORE_PASSWORD

See Also:

• Constant Field Values

SESSION_USER_QUERY_PARAMETER

public static final String SESSION_USER_QUERY_PARAMETER

See Also:

• Constant Field Values

POST_PROXY_HEADERS_TO_FORWARD

public static final String POST_PROXY_HEADERS_TO_FORWARD

See Also:

• Constant Field Values

SESSION_USER_CONFIGURATION_TABLE

public static final String SESSION_USER_CONFIGURATION_TABLE

See Also:

• Constant Field Values

TIMEOUT

public static final String TIMEOUT

See Also:

• Constant Field Values

USER_ID

public static final String USER_ID

See Also:

• Constant Field Values

PASSWORD

public static final String PASSWORD

See Also:

• Constant Field Values

AUTHORIZATION_SERVER_ID

public static final String AUTHORIZATION_SERVER_ID

See Also:

• Constant Field Values

AUTHENTICATION_TYPE

public static final String AUTHENTICATION_TYPE

See Also:

• Constant Field Values

AUTHENTICATION_TYPE_NONE

public static final String AUTHENTICATION_TYPE_NONE

See Also:

• Constant Field Values

AUTHENTICATION_TYPE_BASIC

public static final String AUTHENTICATION_TYPE_BASIC

See Also:

• Constant Field Values

AUTHENTICATION_TYPE_SSO

public static final String AUTHENTICATION_TYPE_SSO

See Also:

• Constant Field Values

AUTHENTICATION_TYPE_OAUTH_M2M

public static final String AUTHENTICATION_TYPE_OAUTH_M2M

See Also:

• Constant Field Values

AUTHENTICATION_TYPE_SESSION_USER

public static final String AUTHENTICATION_TYPE_SESSION_USER

See Also:

• Constant Field Values

CONFIGURATION_SCOPE_TABLE_NAME

public static final String CONFIGURATION_SCOPE_TABLE_NAME

See Also:

• Constant Field Values

FLOW_CONNECTOR_CONFIGURATION

public static final String FLOW_CONNECTOR_CONFIGURATION

See Also:

• Constant Field Values

FLOW_CONNECTION_NAME

public static final String FLOW_CONNECTION_NAME

See Also:

• Constant Field Values

SCOPE

public static final String SCOPE

See Also:

• Constant Field Values

Constructor Details

MediaEntity

public MediaEntity()

Method Details

getImage

@ThingworxExtensionApiMethod(since={6,6})
public ImagePrimitive getImage()
                        throws Exception

Throws:

Exception - If an error occurs

GetImage

@ThingworxExtensionApiMethod(since={6,6})
public byte[] GetImage()
                throws Exception

Service Category:

Images

Service Description:

Get the content as an image.

Returns:

result Image content - IMAGE

Throws:

Exception - If an error occurs

GetMimeType

@ThingworxExtensionApiMethod(since={6,6})
public String GetMimeType()
                   throws Exception

Service Category:

Images

Service Description:

Get the mime type.

Returns:

result Image mime type - STRING

Throws:

Exception - If an error occurs

getEntityType

@ThingworxExtensionApiMethod(since={6,6})
public RelationshipTypes.ThingworxRelationshipTypes getEntityType()

Description copied from class: RootEntity

Returns the type of this entity.

Specified by:

getEntityType in class RootEntity

Returns:

the entity type

GetProxyUrl

@ThingworxExtensionApiMethod(since={7,4},
                             deprecatedSince={8,5})
@Deprecated
public String GetProxyUrl(String targetUrl,
 Boolean isAbsoluteTargetUrl)
                   throws Exception

Deprecated.

As of release 8.5.0, replaced by GetProxyUrl(String, Boolean, Boolean)

Parameters:

targetUrl - Actual URL of content to stream. Must be under the configured origin server

isAbsoluteTargetUrl - Is the provided target URL an absolute URL or relative.

Returns:

proxy URL to remote content

Throws:

Exception

GetProxyUrl

@ThingworxExtensionApiMethod(since={8,5})
public String GetProxyUrl(String targetUrl,
 Boolean isAbsoluteTargetUrl,
 Boolean clientFollowsRedirect)
                   throws Exception

Service Category:

Images

Service Description:

Get a URL to proxy content relative to the configured origin server.

Parameters:

targetUrl - Actual URL of content to stream. Must be under the configured origin server - STRING

isAbsoluteTargetUrl - Is the provided target URL an absolute URL or relative. - BOOLEAN

clientFollowsRedirect - If the response of the proxied URL is of redirect type, then whether the client should call the redirected url or media entity.Set this flag value to true if client should follow the redirect rather than Media Entity - BOOLEAN

Returns:

result proxy URL to remote content - STRING

Throws:

Exception - If an error occurs

fromJSON

@Deprecated
@ThingworxExtensionApiMethod(since={6,6},
                             deprecatedSince={8,4})
public static MediaEntity fromJSON(org.json.JSONObject jsonObject)
                            throws Exception

Deprecated.

Throws:

Exception - If an error occurs