uPortal 2.4.1
API Documentation

org.jasig.portal.security
Interface IAuthorizationPrincipal

All Known Implementing Classes:
AuthorizationPrincipalImpl

public interface IAuthorizationPrincipal

An IAuthorizationPrincipal represents a portal entity to which IPermissions have been granted. Such an entity could be an IGroupMember, an IChannel or an IPerson.

Version:
$Revision: 1.7 $
Author:
Dan Ellentuck

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.
 IPermission[] getAllPermissions()
          Returns the IPermissions for this IAuthorizationPrincipal, including inherited Permissions.
 IPermission[] getAllPermissions(java.lang.String owner, java.lang.String activity, java.lang.String target)
          Returns the IPermissions for this IAuthorizationPrincipal for the specified owner, activity and target.
 java.util.Vector getAuthorizedChannels()
          Return a Vector of IChannels.
 java.lang.String getKey()
          Returns the key of the underlying entity.
 IPermission[] getPermissions()
          Returns the IPermissions for this IAuthorizationPrincipal.
 IPermission[] getPermissions(java.lang.String owner, java.lang.String activity, java.lang.String target)
          Returns the IPermissions for this IAuthorizationPrincipal for the specified owner, activity and target.
 java.lang.String getPrincipalString()
           
 java.lang.Class getType()
          Return the Type of the underlying entity.
 boolean hasPermission(java.lang.String owner, java.lang.String activity, java.lang.String target)
          Answers if this IAuthorizationPrincipal has permission to perform the activity on the target.
 boolean hasPermission(java.lang.String owner, java.lang.String activity, java.lang.String target, IPermissionPolicy policy)
          Answers if this IAuthorizationPrincipal has permission to perform the activity on the target, as evaluated by the policy.
 

Method Detail

canPublish

public boolean canPublish()
                   throws AuthorizationException
Answers if this IAuthorizationPrincipal has permission to publish.

Returns:
boolean
Throws:
AuthorizationException - thrown when authorization information could not be retrieved.

canRender

public boolean canRender(int channelPublishId)
                  throws AuthorizationException
Answers if this IAuthoriztionPrincipal has permission to render this channel.

Parameters:
channelPublishId - int - the Channel publish Id
Returns:
boolean
Throws:
AuthorizationException - thrown when authorization information could not be retrieved.

canSubscribe

public boolean canSubscribe(int channelPublishId)
                     throws AuthorizationException
Answers if this IAuthorizationPrincipal has permission to subscribe to this channel.

Parameters:
channelPublishId - int - the Channel Id
Returns:
boolean
Throws:
AuthorizationException - thrown when authorization information could not be retrieved.

getAllPermissions

public IPermission[] getAllPermissions()
                                throws AuthorizationException
Returns the IPermissions for this IAuthorizationPrincipal, including inherited Permissions.

Returns:
org.jasig.portal.security.IPermission[]
Throws:
AuthorizationException - indicates authorization information could not be retrieved.

getAllPermissions

public IPermission[] getAllPermissions(java.lang.String owner,
                                       java.lang.String activity,
                                       java.lang.String target)
                                throws AuthorizationException
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.

Parameters:
owner - java.lang.String
activity - java.lang.String
target - java.lang.String
Returns:
org.jasig.portal.security.IPermission[]
Throws:
AuthorizationException - indicates authorization information could not be retrieved.

getAuthorizedChannels

public java.util.Vector getAuthorizedChannels()
                                       throws AuthorizationException
Return a Vector of IChannels.

Returns:
a java.util.Vector of IChannels
Throws:
AuthorizationException - indicates authorization information could not be retrieved.

getKey

public java.lang.String getKey()
Returns the key of the underlying entity.

Returns:
java.lang.String

getPermissions

public IPermission[] getPermissions()
                             throws AuthorizationException
Returns the IPermissions for this IAuthorizationPrincipal.

Returns:
org.jasig.portal.security.IPermission[]
Throws:
AuthorizationException - indicates authorization information could not be retrieved.

getPermissions

public IPermission[] getPermissions(java.lang.String owner,
                                    java.lang.String activity,
                                    java.lang.String target)
                             throws AuthorizationException
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.

Parameters:
owner - java.lang.String
activity - java.lang.String
target - java.lang.String
Returns:
org.jasig.portal.security.IPermission[]
Throws:
AuthorizationException - indicates authorization information could not be retrieved.

getPrincipalString

public java.lang.String getPrincipalString()
Returns:
java.lang.String

getType

public java.lang.Class getType()
Return the Type of the underlying entity.

Returns:
java.lang.Class

hasPermission

public boolean hasPermission(java.lang.String owner,
                             java.lang.String activity,
                             java.lang.String target)
                      throws AuthorizationException
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.

Parameters:
owner - java.lang.String
activity - java.lang.String
target - java.lang.String
Returns:
boolean
Throws:
AuthorizationException - indicates authorization information could not be retrieved.

hasPermission

public boolean hasPermission(java.lang.String owner,
                             java.lang.String activity,
                             java.lang.String target,
                             IPermissionPolicy policy)
                      throws AuthorizationException
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.

Parameters:
owner - java.lang.String
activity - java.lang.String
target - java.lang.String
policy - org.jasig.portal.security.IPermissionPolicy
Returns:
boolean
Throws:
AuthorizationException - indicates authorization information could not be retrieved.

uPortal 2.4.1
API Documentation