| org.jasig.portal.security.IAuthorizationPrincipal
All known Subclasses: org.jasig.portal.security.provider.AuthorizationPrincipalImpl,
IAuthorizationPrincipal | public interface IAuthorizationPrincipal (Code) | | An IAuthorizationPrincipal represents a portal entity to which
IPermissions have been granted. Such an entity could be an IGroupMember ,
an IChannel or an IPerson .
author: Dan Ellentuck version: $Revision: 34783 $ |
Method Summary | |
boolean | canPublish() Answers if this IAuthorizationPrincipal has permission to publish. | boolean | canRender(int channelPublishId) Answers if this IAuthoriztionPrincipal has permission to render this channel. | boolean | canSubscribe(int channelPublishId) Answers if this IAuthorizationPrincipal has permission to subscribe to this channel. | public IPermission[] | getAllPermissions() Returns the IPermissions for this IAuthorizationPrincipal ,
including inherited Permissions . | public IPermission[] | getAllPermissions(String owner, String activity, String target) Returns the IPermissions for this IAuthorizationPrincipal for the
specified owner , activity and target . | public Vector | getAuthorizedChannels() Return a Vector of IChannels. | public String | getKey() Returns the key of the underlying entity. | public IPermission[] | getPermissions() Returns the IPermissions for this IAuthorizationPrincipal . | public IPermission[] | getPermissions(String owner, String activity, String target) Returns the IPermissions for this IAuthorizationPrincipal for the
specified owner , activity and target . | public String | getPrincipalString() | public Class | getType() Return the Type of the underlying entity. | public boolean | hasPermission(String owner, String activity, String target) Answers if this IAuthorizationPrincipal has permission to perform the
activity on the target . | public boolean | hasPermission(String owner, String activity, String target, IPermissionPolicy policy) Answers if this IAuthorizationPrincipal has permission to perform the
activity on the target , as evaluated by the
policy . |
canRender | boolean canRender(int channelPublishId) throws AuthorizationException(Code) | | Answers if this IAuthoriztionPrincipal has permission to render this channel.
boolean Parameters: channelPublishId - int - the Channel publish Id exception: AuthorizationException - thrown when authorization information could not be retrieved. |
canSubscribe | boolean canSubscribe(int channelPublishId) throws AuthorizationException(Code) | | Answers if this IAuthorizationPrincipal has permission to subscribe to this channel.
boolean Parameters: channelPublishId - int - the Channel Id exception: AuthorizationException - thrown when authorization information could not be retrieved. |
getAllPermissions | public IPermission[] getAllPermissions() throws AuthorizationException(Code) | | Returns the IPermissions for this IAuthorizationPrincipal ,
including inherited Permissions .
org.jasig.portal.security.IPermission[] exception: AuthorizationException - indicates authorization information could notbe retrieved. |
getAllPermissions | public IPermission[] getAllPermissions(String owner, String activity, String target) throws AuthorizationException(Code) | | Returns the IPermissions for this IAuthorizationPrincipal for the
specified owner , activity and target . This includes
inherited IPermissions . Null parameters are ignored, so
getPermissions(null, null, null) should retrieve all IPermissions
for an IAuthorizationPrincipal .
org.jasig.portal.security.IPermission[] Parameters: owner - java.lang.String Parameters: activity - java.lang.String Parameters: target - java.lang.String exception: AuthorizationException - indicates authorization information could notbe retrieved. |
getKey | public String getKey()(Code) | | Returns the key of the underlying entity.
java.lang.String |
getPermissions | public IPermission[] getPermissions(String owner, String activity, String target) throws AuthorizationException(Code) | | Returns the IPermissions for this IAuthorizationPrincipal for the
specified owner , activity and target . Null parameters
are ignored, so getPermissions(null, null, null) should retrieve all
IPermissions for an IAuthorizationPrincipal .
org.jasig.portal.security.IPermission[] Parameters: owner - java.lang.String Parameters: activity - java.lang.String Parameters: target - java.lang.String exception: AuthorizationException - indicates authorization information could notbe retrieved. |
getPrincipalString | public String getPrincipalString()(Code) | | java.lang.String |
getType | public Class getType()(Code) | | Return the Type of the underlying entity.
java.lang.Class |
hasPermission | public boolean hasPermission(String owner, String activity, String target) throws AuthorizationException(Code) | | Answers if this IAuthorizationPrincipal has permission to perform the
activity on the target . Params owner and
activity must be non-null. If target is null, then the
target is not checked.
boolean Parameters: owner - java.lang.String Parameters: activity - java.lang.String Parameters: target - java.lang.String exception: AuthorizationException - indicates authorization information could notbe retrieved. |
hasPermission | public boolean hasPermission(String owner, String activity, String target, IPermissionPolicy policy) throws AuthorizationException(Code) | | Answers if this IAuthorizationPrincipal has permission to perform the
activity on the target , as evaluated by the
policy . Params policy , owner and
activity must be non-null.
boolean Parameters: owner - java.lang.String Parameters: activity - java.lang.String Parameters: target - java.lang.String Parameters: policy - org.jasig.portal.security.IPermissionPolicy exception: AuthorizationException - indicates authorization information could notbe retrieved. |
|
|