November Happy Hour will be moved to Thursday December 5th.

AI OnAI Off

Class UnifiedPathInfo

Data class for read ACL defined on unified files and directories.

Inheritance
System.Object
UnifiedPathInfo
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.DataAbstraction
Assembly: EPiServer.dll
Version: 8.11.0
Syntax
public class UnifiedPathInfo

Constructors

UnifiedPathInfo()

Initializes a new instance of the UnifiedPathInfo class.

Declaration
public UnifiedPathInfo()

UnifiedPathInfo(String)

Initializes a new instance of the UnifiedPathInfo class with a specified path.

Declaration
public UnifiedPathInfo(string path)
Parameters
Type Name Description
System.String path

The path.

Properties

Access

Gets or sets the ACL.

Declaration
public AccessControlList Access { get; set; }
Property Value
Type Description
AccessControlList

The access.

ACLQualifier

Indicates if this instance is loaded from db and is not inherited and not an undefined root.

Declaration
public bool ACLQualifier { get; }
Property Value
Type Description
System.Boolean

true if stored in database; otherwise, false.

ID

Gets or sets the ID.

Declaration
public int ID { get; set; }
Property Value
Type Description
System.Int32

The ID.

InheritAcl

Gets or sets a value indicating whether to inherit ACL information from parent.

Declaration
public bool InheritAcl { get; set; }
Property Value
Type Description
System.Boolean

true if ACL information should be inherited; otherwise, false.

IsNew

Gets a value indicating whether this instance is new, ie. not previously saved.

Declaration
public bool IsNew { get; }
Property Value
Type Description
System.Boolean

true if this instance is new; otherwise, false.

MetaData

Gets the associated meta data.

Declaration
public IDictionary MetaData { get; }
Property Value
Type Description
System.Collections.IDictionary

The meta data.

Path

Gets or sets the path.

Declaration
public string Path { get; set; }
Property Value
Type Description
System.String

The path.

Methods

ClearAclForMembership(String, SecurityEntityType)

Clears the acl for the given user or role.

Declaration
public static void ClearAclForMembership(string userOrRoleName, SecurityEntityType securityEntityType)
Parameters
Type Name Description
System.String userOrRoleName

Name of the user or role.
SecurityEntityType securityEntityType

The SecurityEntityType of the user/role.

ClearCache()

Clears all cached UnifiedPathInfo objects.

Declaration
public static void ClearCache()

Delete()

Deletes the UnifiedPathInfo entry from database and removes its memory cached object.

Declaration
public void Delete()

DeleteAll()

Deletes all UnifiedPathInfo data from database and cache.

Declaration
public static void DeleteAll()

GetQualifiedUnifiedPathInfo(String)

Gets the UnifiedPathInfo that is the one that qualifies the ACL for the given path. If the item is not qualified (either by it self or none other item in parent chain) null is returned.

Declaration
public static UnifiedPathInfo GetQualifiedUnifiedPathInfo(string virtualPath)
Parameters
Type Name Description
System.String virtualPath

The virtual path.
Returns
Type Description
UnifiedPathInfo

The UnifiedPathInfo

IsAccessAllowed(IPrincipal)

Determines whether a specified principal has at least read access to the path.

Declaration
public bool IsAccessAllowed(IPrincipal principal)
Parameters
Type Name Description
System.Security.Principal.IPrincipal principal

The principal.
Returns
Type Description
System.Boolean

true if principal has access; otherwise, false.

IsAccessAllowed(String)

Determines whether the current principal has at least read access to a specified path.

Declaration
public static bool IsAccessAllowed(string userPath)
Parameters
Type Name Description
System.String userPath

The user path.
Returns
Type Description
System.Boolean

true if principal has access; otherwise, false.

IsAccessAllowed(String, IPrincipal)

Determines whether a specified principal has at least read access to the specified path.

Declaration
public static bool IsAccessAllowed(string userPath, IPrincipal principal)
Parameters
Type Name Description
System.String userPath

The user path.
System.Security.Principal.IPrincipal principal

The principal.
Returns
Type Description
System.Boolean

true if principal has access; otherwise, false.

Load(String)

Loads the object based upon the virtualpath.

Declaration
public static UnifiedPathInfo Load(string path)
Parameters
Type Name Description
System.String path
Returns
Type Description
UnifiedPathInfo

MoveAll(String, String)

Moves all entries with a fromPath to a new toPath.

Declaration
public static void MoveAll(string fromPath, string toPath)
Parameters
Type Name Description
System.String fromPath
System.String toPath

Save()

Saves this UnifiedPathInfo instance to the database.

Declaration
public void Save()

Save(SecuritySaveType)

Saves the UnifiedPathInfo object to database.

Declaration
[Obsolete("saveType is ignored, use another overload")]
public void Save(SecuritySaveType saveType)
Parameters
Type Name Description
SecuritySaveType saveType

A SecuritySaveType. Ignored

Search(String, IDictionary<String, String>)

Searches the specified path.

Declaration
public static StringCollection Search(string path, IDictionary<string, string> search)
Parameters
Type Name Description
System.String path

The path.
System.Collections.Generic.IDictionary<System.String, System.String> search

The search.
Returns
Type Description
System.Collections.Specialized.StringCollection

Extension Methods