[Minor] added JavaDoc to new policies

This commit is contained in:
Robert von Burg 2015-03-18 20:11:45 +01:00
parent 2076675ca5
commit 3f7636428d
3 changed files with 16 additions and 3 deletions

View File

@ -28,7 +28,10 @@ import ch.eitchnet.utils.collections.Tuple;
import ch.eitchnet.utils.dbc.DBC;
/**
* TODO
* This {@link PrivilegePolicy} expects a {@link Tuple} as {@link Restrictable#getPrivilegeValue()}. The Tuple must
* contain {@link Role} as first and second value. Then the policy decides depending on the user specific privileges
* (see {@link PrivilegeHandler}), uses the basic <code>Allow</code> and <code>Deny</code> to detect if the username of
* the certificate is allowed
*
* @author Robert von Burg <eitch@eitchnet.ch>
*/

View File

@ -28,7 +28,9 @@ import ch.eitchnet.utils.collections.Tuple;
import ch.eitchnet.utils.dbc.DBC;
/**
* TODO
* This {@link PrivilegePolicy} expects a {@link Tuple} as {@link Restrictable#getPrivilegeValue()} and then depending
* on the user specific privileges (see {@link PrivilegeHandler}), uses the basic <code>Allow</code> and
* <code>Deny</code> to detect if the username of the certificate is allowed
*
* @author Robert von Burg <eitch@eitchnet.ch>
*/

View File

@ -25,7 +25,15 @@ import ch.eitchnet.privilege.model.PrivilegeContext;
import ch.eitchnet.privilege.model.Restrictable;
/**
* TODO
* <p>
* This {@link PrivilegePolicy} expects a {@link Certificate} as {@link Restrictable#getPrivilegeValue()} and uses the
* basic <code>Allow</code> and <code>Deny</code> to detect if the username of the certificate is allowed.
* </p>
*
* <p>
* The {@link Certificate} as privilegeValue is not to be confused with the {@link Certificate} of the current user.
* This certificate is of the user to which access is request, i.e. modifying the session of a logged in user.
* </p>
*
* @author Robert von Burg <eitch@eitchnet.ch>
*/