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:

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

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	_logger
static java.lang.String	AUTHENTICATION_TYPE
static java.lang.String	AUTHENTICATION_TYPE_BASIC
static java.lang.String	AUTHENTICATION_TYPE_NONE
static java.lang.String	AUTHENTICATION_TYPE_SESSION_USER
static java.lang.String	AUTHENTICATION_TYPE_SSO
static java.lang.String	AUTHORIZATION_SERVER_ID
static java.lang.String	CONFIG_TABLE_CONTENT_SOURCE_CONNECTION_INFO
static java.lang.String	CONFIGURATION_SCOPE_TABLE_NAME
static java.lang.String	DYNAMIC_CONTENT
static java.lang.String	IGNORE_SSL_ERRORS
static java.lang.String	PASSWORD
static java.lang.String	SCOPE
static java.lang.String	SESSION_USER_CONFIGURATION_TABLE
static java.lang.String	SESSION_USER_QUERY_PARAMETER
static java.lang.String	SSL_CONFIG_TABLE
static java.lang.String	SSL_KEYSTORE_PASSWORD
static java.lang.String	SSL_KEYSTORE_PATH
static java.lang.String	SSL_TRUSTSTORE_PASSWORD
static java.lang.String	SSL_TRUSTSTORE_PATH
static java.lang.String	TEST_URL
static java.lang.String	TIMEOUT
static java.lang.String	URL
static java.lang.String	USER_ID

Fields inherited from class com.thingworx.entities.RootEntity

BASIC_PROPERTIES

Fields inherited from class com.thingworx.types.NamedObject

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
MediaEntity()

Method Summary

Modifier and Type	Method and 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.
java.lang.String	GetMimeType() Service Category: Images Service Description: Get the mime type.
java.lang.String	GetProxyUrl(java.lang.String targetUrl, java.lang.Boolean isAbsoluteTargetUrl) Deprecated. As of release 8.5.0, replaced by GetProxyUrl(String, Boolean, Boolean)
java.lang.String	GetProxyUrl(java.lang.String targetUrl, java.lang.Boolean isAbsoluteTargetUrl, java.lang.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, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, AddTags, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, 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, 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, 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, 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.entities.interfaces.IPersistable

getID, hasID

Methods inherited from interface com.thingworx.types.INamedObject

getDescription, getName

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

getID, getName

Field Detail

_logger

public static org.slf4j.Logger _logger

CONFIG_TABLE_CONTENT_SOURCE_CONNECTION_INFO

public static final java.lang.String CONFIG_TABLE_CONTENT_SOURCE_CONNECTION_INFO

See Also:

Constant Field Values

DYNAMIC_CONTENT

public static final java.lang.String DYNAMIC_CONTENT

See Also:

Constant Field Values

URL

public static final java.lang.String URL

See Also:

Constant Field Values

TEST_URL

public static final java.lang.String TEST_URL

See Also:

Constant Field Values

IGNORE_SSL_ERRORS

public static final java.lang.String IGNORE_SSL_ERRORS

See Also:

Constant Field Values

SSL_CONFIG_TABLE

public static final java.lang.String SSL_CONFIG_TABLE

See Also:

Constant Field Values

SSL_KEYSTORE_PATH

public static final java.lang.String SSL_KEYSTORE_PATH

See Also:

Constant Field Values

SSL_KEYSTORE_PASSWORD

public static final java.lang.String SSL_KEYSTORE_PASSWORD

See Also:

Constant Field Values

SSL_TRUSTSTORE_PATH

public static final java.lang.String SSL_TRUSTSTORE_PATH

See Also:

Constant Field Values

SSL_TRUSTSTORE_PASSWORD

public static final java.lang.String SSL_TRUSTSTORE_PASSWORD

See Also:

Constant Field Values

SESSION_USER_QUERY_PARAMETER

public static final java.lang.String SESSION_USER_QUERY_PARAMETER

See Also:

Constant Field Values

SESSION_USER_CONFIGURATION_TABLE

public static final java.lang.String SESSION_USER_CONFIGURATION_TABLE

See Also:

Constant Field Values

TIMEOUT

public static final java.lang.String TIMEOUT

See Also:

Constant Field Values

USER_ID

public static final java.lang.String USER_ID

See Also:

Constant Field Values

PASSWORD

public static final java.lang.String PASSWORD

See Also:

Constant Field Values

AUTHORIZATION_SERVER_ID

public static final java.lang.String AUTHORIZATION_SERVER_ID

See Also:

Constant Field Values

AUTHENTICATION_TYPE

public static final java.lang.String AUTHENTICATION_TYPE

See Also:

Constant Field Values

AUTHENTICATION_TYPE_NONE

public static final java.lang.String AUTHENTICATION_TYPE_NONE

See Also:

Constant Field Values

AUTHENTICATION_TYPE_BASIC

public static final java.lang.String AUTHENTICATION_TYPE_BASIC

See Also:

Constant Field Values

AUTHENTICATION_TYPE_SSO

public static final java.lang.String AUTHENTICATION_TYPE_SSO

See Also:

Constant Field Values

AUTHENTICATION_TYPE_SESSION_USER

public static final java.lang.String AUTHENTICATION_TYPE_SESSION_USER

See Also:

Constant Field Values

CONFIGURATION_SCOPE_TABLE_NAME

public static final java.lang.String CONFIGURATION_SCOPE_TABLE_NAME

See Also:

Constant Field Values

SCOPE

public static final java.lang.String SCOPE

See Also:

Constant Field Values

Constructor Detail

MediaEntity

public MediaEntity()

Method Detail

getImage

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

Throws:

java.lang.Exception - If an error occurs

GetImage

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

Service Category:

Images

Service Description:

Get the content as an image.

Returns:

result Image content - IMAGE

Throws:

java.lang.Exception - If an error occurs

GetMimeType

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

Service Category:

Images

Service Description:

Get the mime type.

Returns:

result Image mime type - STRING

Throws:

java.lang.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 java.lang.String GetProxyUrl(java.lang.String targetUrl,
                                                                                                                                               java.lang.Boolean isAbsoluteTargetUrl)
                                                                                                                                        throws java.lang.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:

java.lang.Exception

GetProxyUrl

@ThingworxExtensionApiMethod(since={8,5})
public java.lang.String GetProxyUrl(java.lang.String targetUrl,
                                                                              java.lang.Boolean isAbsoluteTargetUrl,
                                                                              java.lang.Boolean clientFollowsRedirect)
                                                                       throws java.lang.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:

java.lang.Exception - If an error occurs

fromJSON

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

Deprecated.

Throws:

java.lang.Exception - If an error occurs