|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
.
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 |
---|
boolean canPublish() throws AuthorizationException
IAuthorizationPrincipal
has permission to publish.
AuthorizationException
- thrown when authorization information could not be retrieved.boolean canRender(int channelPublishId) throws AuthorizationException
IAuthoriztionPrincipal
has permission to render this channel.
channelPublishId
- int - the Channel publish Id
AuthorizationException
- thrown when authorization information could not be retrieved.boolean canSubscribe(int channelPublishId) throws AuthorizationException
IAuthorizationPrincipal
has permission to subscribe to this channel.
channelPublishId
- int - the Channel Id
AuthorizationException
- thrown when authorization information could not be retrieved.IPermission[] getAllPermissions() throws AuthorizationException
IPermissions
for this IAuthorizationPrincipal
,
including inherited Permissions
.
AuthorizationException
- indicates authorization information could not
be retrieved.IPermission[] getAllPermissions(java.lang.String owner, java.lang.String activity, java.lang.String target) throws AuthorizationException
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
.
owner
- java.lang.Stringactivity
- java.lang.Stringtarget
- java.lang.String
AuthorizationException
- indicates authorization information could not
be retrieved.java.util.Vector getAuthorizedChannels() throws AuthorizationException
java.util.Vector
of IChannels
AuthorizationException
- indicates authorization information could not be retrieved.java.lang.String getKey()
IPermission[] getPermissions() throws AuthorizationException
IPermissions
for this IAuthorizationPrincipal
.
AuthorizationException
- indicates authorization information could not
be retrieved.IPermission[] getPermissions(java.lang.String owner, java.lang.String activity, java.lang.String target) throws AuthorizationException
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
.
owner
- java.lang.Stringactivity
- java.lang.Stringtarget
- java.lang.String
AuthorizationException
- indicates authorization information could not
be retrieved.java.lang.String getPrincipalString()
java.lang.Class getType()
boolean hasPermission(java.lang.String owner, java.lang.String activity, java.lang.String target) throws AuthorizationException
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.
owner
- java.lang.Stringactivity
- java.lang.Stringtarget
- java.lang.String
AuthorizationException
- indicates authorization information could not
be retrieved.boolean hasPermission(java.lang.String owner, java.lang.String activity, java.lang.String target, IPermissionPolicy policy) throws AuthorizationException
IAuthorizationPrincipal
has permission to perform the
activity
on the target
, as evaluated by the
policy
. Params policy
, owner
and
activity
must be non-null.
owner
- java.lang.Stringactivity
- java.lang.Stringtarget
- java.lang.Stringpolicy
- org.jasig.portal.security.IPermissionPolicy
AuthorizationException
- indicates authorization information could not
be retrieved.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |