Package com.thingworx.security.directoryservices

Class DirectoryService

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.entities.ServiceProviderEntity

com.thingworx.entities.ExtensibleRootEntity

com.thingworx.security.directoryservices.DirectoryService

All Implemented Interfaces:

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

@ThingworxExtensionApiClass(since={6,6},
                            canExtendOrImplement=true,
                            canInstantiate=true)
public class DirectoryService
extends ExtensibleRootEntity

See Also:

Serialized Form

Field Summary

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
DirectoryService()

Method Summary

Modifier and Type	Method	Description
RelationshipTypes.ThingworxRelationshipTypes	getEntityType()
int	getPriority()
void	initializeEntity(ContextType contextType)
boolean	isEnabled()
void	setEnabled(boolean value)
void	setPriority(int value)
void	validateCredentials(java.lang.String userName, java.lang.String password)
void	validateCredentials(java.lang.String userName, java.lang.String password, javax.servlet.http.HttpServletRequest req)
void	ValidateCredentials(User user, java.lang.String password)	Deprecated. Implement validateCredentials(String, String) instead.
void	ValidateCredentials(User user, java.lang.String password, javax.servlet.http.HttpServletRequest req)	Deprecated. Implement validateCredentials(String, String, HttpServletRequest) instead.

Methods inherited from class com.thingworx.entities.ServiceProviderEntity

getInstancePublicServiceDefinitions, getInstanceServiceDefinition, getInstanceServiceDefinitions, 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.deprecation.ISupportsDeprecation

getDeprecated, isDeprecated, isDeprecatedBefore, since

Constructor Detail

DirectoryService

public DirectoryService()

Method Detail

isEnabled

@ThingworxExtensionApiMethod(since={6,6})
public boolean isEnabled()

setEnabled

@ThingworxExtensionApiMethod(since={6,6})
public void setEnabled(boolean value)

getPriority

@ThingworxExtensionApiMethod(since={6,6})
public int getPriority()

setPriority

@ThingworxExtensionApiMethod(since={6,6})
public void setPriority(int value)

validateCredentials

@ThingworxExtensionApiMethod(since={7,3},
                             canOverride=true)
public void validateCredentials(java.lang.String userName,
                                java.lang.String password)
                         throws java.lang.Exception

Throws:

java.lang.Exception - If an error occurs

validateCredentials

@ThingworxExtensionApiMethod(since={7,3},
                             canOverride=true)
public void validateCredentials(java.lang.String userName,
                                java.lang.String password,
                                javax.servlet.http.HttpServletRequest req)
                         throws java.lang.Exception

Throws:

java.lang.Exception - If an error occurs

ValidateCredentials

@ThingworxExtensionApiMethod(since={6,6},
                             canOverride=true)
@Deprecated
public void ValidateCredentials(User user,
                                java.lang.String password)
                         throws java.lang.Exception

Deprecated.

Implement validateCredentials(String, String) instead.

Throws:

java.lang.Exception - If an error occurs

ValidateCredentials

@ThingworxExtensionApiMethod(since={6,6},
                             canOverride=true)
@Deprecated
public void ValidateCredentials(User user,
                                java.lang.String password,
                                javax.servlet.http.HttpServletRequest req)
                         throws java.lang.Exception

Deprecated.

Implement validateCredentials(String, String, HttpServletRequest) instead.

Throws:

java.lang.Exception - If an error occurs

initializeEntity

@ThingworxExtensionApiMethod(since={9,0},
                             canOverride=true)
public void initializeEntity(ContextType contextType)
                      throws java.lang.Exception

Description copied from class: RootEntity

Initializes the internal state of the entity. This method may be called more than once on the same entity during initialization.

All metadata, including aspects and configuration tables, are available at this point in the lifecycle.

Overrides:

initializeEntity in class ServiceProviderEntity

Parameters:

contextType - the patch operation

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