Simias::Policy::PolicyManager Class Reference

Collection Store policy manager. More...

Collaboration diagram for Simias::Policy::PolicyManager:

List of all members.

Public Member Functions

PolicyManager ()

Initializes a new instance of this object.

void CommitLocalMachinePolicy (Policy policy)

Saves and associates the Policy with the current user on the current machine. This Policy will not be effective for any other user that is being impersonated. The caller must possess Admin rights in order to commit a Policy.

void CommitPolicy (Policy policy)

Saves and associates the Policy how it was previously committed. If the policy has not been previously committed an exception is thrown. The caller must possess Admin rights in order to commit a Policy.

void CommitPolicy (Policy policy, string domainID)

Saves and associates the Policy with the domain. The caller must possess Admin rights in order to commit a Policy.

void CommitPolicy (string policyID, ICSList ruleList, Member member)

Saves and associates the Policy with the user. The caller must possess Admin rights in order to commit a Policy.

void CommitPolicy (string policyID, object value, Member member)

Saves and associates the Policy with the user. The caller must possess Admin rights in order to commit a Policy.

void CommitPolicy (Policy policy, Collection collection)

Saves and associates the Policy with the collection. The caller must possess Admin rights in order to commit a Policy.

void DeletePolicy (Policy policy)

Deletes the Policy.

void DeletePolicy (string policyID, Member member)

Deletes the Policy associated with a member .

Policy GetAggregatePolicy (string policyID, Member member)

Gets an aggregate Policy that is associated with the user. This routine will check for an associated Policy on the Member first. If no Policy is found, the domain will be searched for an associated Policy. If there is a local Policy for the user it will be aggregated with the other Policy if one was found. Otherwise it will be returned.

Policy GetAggregatePolicy (string policyID, Member member, Collection collection)

Gets an aggregate Policy that is associated with the user and the specified Collection. This routine will check for an associated Policy on the Member first. If no Policy is found, the domain will be searched for an associated Policy. If there is a local Policy for the user it will be aggregated with the other Policy if one was found. Otherwise it will be returned. The procedure for the local Policy is also followed for an associated Collection Policy.

Policy GetAggregatePolicy (string policyID, Member member, bool includeExceptions)

Gets an aggregate Policy that is associated with the user. This routine will check for an associated Policy on the Member first. If no Policy is found, the domain will be searched for an associated Policy. If there is a local Policy for the user it will be aggregated with the other Policy if one was found. Otherwise it will be returned.

Policy GetAggregatePolicy (string policyID, Member member, Collection collection, bool includeExceptions)

Gets an aggregate Policy that is associated with the user and the specified Collection. This routine will check for an associated Policy on the Member first. If no Policy is found, the domain will be searched for an associated Policy. If there is a local Policy for the user it will be aggregated with the other Policy if one was found. Otherwise it will be returned. The procedure for the local Policy is also followed for an associated Collection Policy.

Policy GetPolicy (string policyID)

Gets the Policy associated with the current user on the current machine.

Policy GetPolicy (string policyID, string domainID)

Gets the Policy that is associated with the domain.

Policy GetPolicy (string policyID, Member member)

Gets the Policy that is associated with the user.

Policy GetPolicy (string policyID, Collection collection)

Gets the Policy that is associated with the collection.

ICSList GetPolicyList (Member member)

Gets a list of all the Policies for the user.

ICSList GetPolicyList (Member member, Collection collection)

Gets a list of all the Policies for the user on the collection.

ICSList GetPolicyList (string domainID)

Gets a list of all the Policies for the domain.

Detailed Description

Collection Store policy manager.

Constructor & Destructor Documentation

Simias::Policy::PolicyManager::PolicyManager ( ) [inline]

Initializes a new instance of this object.

Member Function Documentation

void Simias::Policy::PolicyManager::CommitLocalMachinePolicy ( Policy policy ) [inline]

Saves and associates the Policy with the current user on the current machine. This Policy will not be effective for any other user that is being impersonated. The caller must possess Admin rights in order to commit a Policy.

Parameters:

policy

Policy to be saved.

void Simias::Policy::PolicyManager::CommitPolicy ( Policy policy ) [inline]

Saves and associates the Policy how it was previously committed. If the policy has not been previously committed an exception is thrown. The caller must possess Admin rights in order to commit a Policy.

Parameters:

policy

Policy to be saved.

void Simias::Policy::PolicyManager::CommitPolicy	(	Policy	policy,
		string	domainID
	)			`[inline]`

Saves and associates the Policy with the domain. The caller must possess Admin rights in order to commit a Policy.

Parameters:

	policy	Policy to be saved.
	domainID	Identifier of domain to associate Policy with.

void Simias::Policy::PolicyManager::CommitPolicy	(	string	policyID,
		ICSList	ruleList,
		Member	member
	)			`[inline]`

Saves and associates the Policy with the user. The caller must possess Admin rights in order to commit a Policy.

Parameters:

policyID

Policy identifier to be saved.

<param name='ruleList">Rules to be added to the Policy identifier

Parameters:

member

Member to associate the Policy identifier with.

void Simias::Policy::PolicyManager::CommitPolicy	(	string	policyID,
		object	value,
		Member	member
	)			`[inline]`

Saves and associates the Policy with the user. The caller must possess Admin rights in order to commit a Policy.

Parameters:

	policy	Policy to be saved.
	member	Member to associate the Policy with.

void Simias::Policy::PolicyManager::CommitPolicy	(	Policy	policy,
		Collection	collection
	)			`[inline]`

Saves and associates the Policy with the collection. The caller must possess Admin rights in order to commit a Policy.

Parameters:

	policy	Policy to be saved.
	collection	Collection to associate the Policy with.

void Simias::Policy::PolicyManager::DeletePolicy ( Policy policy ) [inline]

Deletes the Policy.

Parameters:

policy

Policy to delete.

void Simias::Policy::PolicyManager::DeletePolicy	(	string	policyID,
		Member	member
	)			`[inline]`

Deletes the Policy associated with a member .

Parameters:

	policyID	Policy identifier to delete.
	member	member object whom policy is attached to.

Policy Simias::Policy::PolicyManager::GetAggregatePolicy	(	string	policyID,
		Member	member
	)			`[inline]`

Gets an aggregate Policy that is associated with the user. This routine will check for an associated Policy on the Member first. If no Policy is found, the domain will be searched for an associated Policy. If there is a local Policy for the user it will be aggregated with the other Policy if one was found. Otherwise it will be returned.

Parameters:

	policyID	Strong name for the Policy.
	member	Member used to lookup the associated aggregate Policy.

Returns:: A reference to the associated aggregate Policy if successful. A null is returned if the Policy does not exist.

Policy Simias::Policy::PolicyManager::GetAggregatePolicy	(	string	policyID,
		Member	member,
		Collection	collection
	)			`[inline]`

Gets an aggregate Policy that is associated with the user and the specified Collection. This routine will check for an associated Policy on the Member first. If no Policy is found, the domain will be searched for an associated Policy. If there is a local Policy for the user it will be aggregated with the other Policy if one was found. Otherwise it will be returned. The procedure for the local Policy is also followed for an associated Collection Policy.

Parameters:

	policyID	Strong name of the Policy.
	member	Member used to lookup the associated aggregate Policy.
	collection	Collection used to lookup the associated aggregate Policy.

Returns:: A reference to the associated aggregate Policy if successful. A null is returned if the Policy does not exist.

Policy Simias::Policy::PolicyManager::GetAggregatePolicy	(	string	policyID,
		Member	member,
		bool	includeExceptions
	)			`[inline]`

Gets an aggregate Policy that is associated with the user. This routine will check for an associated Policy on the Member first. If no Policy is found, the domain will be searched for an associated Policy. If there is a local Policy for the user it will be aggregated with the other Policy if one was found. Otherwise it will be returned.

Parameters:

	policyID	Strong name for the Policy.
	member	Member used to lookup the associated aggregate Policy.
	includeExceptions	Include exception policies.

Returns:: A reference to the associated aggregate Policy if successful. A null is returned if the Policy does not exist.

Policy Simias::Policy::PolicyManager::GetAggregatePolicy	(	string	policyID,
		Member	member,
		Collection	collection,
		bool	includeExceptions
	)			`[inline]`

Gets an aggregate Policy that is associated with the user and the specified Collection. This routine will check for an associated Policy on the Member first. If no Policy is found, the domain will be searched for an associated Policy. If there is a local Policy for the user it will be aggregated with the other Policy if one was found. Otherwise it will be returned. The procedure for the local Policy is also followed for an associated Collection Policy.

Parameters:

	policyID	Strong name of the Policy.
	member	Member used to lookup the associated aggregate Policy.
	collection	Collection used to lookup the associated aggregate Policy.
	includeExceptions	Include exception policies.

Returns:: A reference to the associated aggregate Policy if successful. A null is returned if the Policy does not exist.

Policy Simias::Policy::PolicyManager::GetPolicy ( string policyID ) [inline]

Gets the Policy associated with the current user on the current machine.

Parameters:

policyID

Strong name of the Policy.

Returns:: A reference to the associated Policy if successful. A null is returned if the Policy does not exist.

Policy Simias::Policy::PolicyManager::GetPolicy	(	string	policyID,
		string	domainID
	)			`[inline]`

Gets the Policy that is associated with the domain.

Parameters:

	policyID	Strong name of the Policy.
	domainID	Identifier for the domain to use to lookup the Policy.

Returns:: A reference to the associated Policy if successful. A null is returned if the Policy does not exist.

Policy Simias::Policy::PolicyManager::GetPolicy	(	string	policyID,
		Member	member
	)			`[inline]`

Gets the Policy that is associated with the user.

Parameters:

	policyID	Strong name of the Policy.
	member	Member used to lookup the associated Policy.

Returns:: A reference to the associated Policy if successful. A null is returned if the Policy does not exist.

Policy Simias::Policy::PolicyManager::GetPolicy	(	string	policyID,
		Collection	collection
	)			`[inline]`

Gets the Policy that is associated with the collection.

Parameters:

	policyID	Strong name of the Policy.
	collection	Collection used to lookup the associated Policy.

Returns:: A reference to the associated Policy if successful. A null is returned if the Policy does not exist.

ICSList Simias::Policy::PolicyManager::GetPolicyList ( Member member ) [inline]

Gets a list of all the Policies for the user.

Parameters:

member

Member to get Policies for.

Returns:: An ICSList that contains all of the Policies that are associated with the user.

ICSList Simias::Policy::PolicyManager::GetPolicyList	(	Member	member,
		Collection	collection
	)			`[inline]`

Gets a list of all the Policies for the user on the collection.

Parameters:

	member	Member to get Policies for.
	collection	Collection that may have associated policies.

Returns:: An ICSList that contains all of the Policies that are associated with the user.

ICSList Simias::Policy::PolicyManager::GetPolicyList ( string domainID ) [inline]

Gets a list of all the Policies for the domain.

Parameters:

domainID

Identifier for a domain.

Returns:: An ICSList that contains all of the Policies that are associated with the domain.

The documentation for this class was generated from the following file:

src/core/CollectionStore/Policy.cs


Public Member Functions
	PolicyManager ()
	Initializes a new instance of this object.
void	CommitLocalMachinePolicy (Policy policy)
	Saves and associates the Policy with the current user on the current machine. This Policy will not be effective for any other user that is being impersonated. The caller must possess Admin rights in order to commit a Policy.
void	CommitPolicy (Policy policy)
	Saves and associates the Policy how it was previously committed. If the policy has not been previously committed an exception is thrown. The caller must possess Admin rights in order to commit a Policy.
void	CommitPolicy (Policy policy, string domainID)
	Saves and associates the Policy with the domain. The caller must possess Admin rights in order to commit a Policy.
void	CommitPolicy (string policyID, ICSList ruleList, Member member)
	Saves and associates the Policy with the user. The caller must possess Admin rights in order to commit a Policy.
void	CommitPolicy (string policyID, object value, Member member)
	Saves and associates the Policy with the user. The caller must possess Admin rights in order to commit a Policy.
void	CommitPolicy (Policy policy, Collection collection)
	Saves and associates the Policy with the collection. The caller must possess Admin rights in order to commit a Policy.
void	DeletePolicy (Policy policy)
	Deletes the Policy.
void	DeletePolicy (string policyID, Member member)
	Deletes the Policy associated with a member .
Policy	GetAggregatePolicy (string policyID, Member member)
	Gets an aggregate Policy that is associated with the user. This routine will check for an associated Policy on the Member first. If no Policy is found, the domain will be searched for an associated Policy. If there is a local Policy for the user it will be aggregated with the other Policy if one was found. Otherwise it will be returned.
Policy	GetAggregatePolicy (string policyID, Member member, Collection collection)
	Gets an aggregate Policy that is associated with the user and the specified Collection. This routine will check for an associated Policy on the Member first. If no Policy is found, the domain will be searched for an associated Policy. If there is a local Policy for the user it will be aggregated with the other Policy if one was found. Otherwise it will be returned. The procedure for the local Policy is also followed for an associated Collection Policy.
Policy	GetAggregatePolicy (string policyID, Member member, bool includeExceptions)
	Gets an aggregate Policy that is associated with the user. This routine will check for an associated Policy on the Member first. If no Policy is found, the domain will be searched for an associated Policy. If there is a local Policy for the user it will be aggregated with the other Policy if one was found. Otherwise it will be returned.
Policy	GetAggregatePolicy (string policyID, Member member, Collection collection, bool includeExceptions)
	Gets an aggregate Policy that is associated with the user and the specified Collection. This routine will check for an associated Policy on the Member first. If no Policy is found, the domain will be searched for an associated Policy. If there is a local Policy for the user it will be aggregated with the other Policy if one was found. Otherwise it will be returned. The procedure for the local Policy is also followed for an associated Collection Policy.
Policy	GetPolicy (string policyID)
	Gets the Policy associated with the current user on the current machine.
Policy	GetPolicy (string policyID, string domainID)
	Gets the Policy that is associated with the domain.
Policy	GetPolicy (string policyID, Member member)
	Gets the Policy that is associated with the user.
Policy	GetPolicy (string policyID, Collection collection)
	Gets the Policy that is associated with the collection.
ICSList	GetPolicyList (Member member)
	Gets a list of all the Policies for the user.
ICSList	GetPolicyList (Member member, Collection collection)
	Gets a list of all the Policies for the user on the collection.
ICSList	GetPolicyList (string domainID)
	Gets a list of all the Policies for the domain.