Package org.bedework.calfacade.svc

Class PrincipalInfo

java.lang.Object

org.bedework.calfacade.svc.PrincipalInfo

All Implemented Interfaces:

Serializable, org.bedework.access.Access.AccessCb

public abstract class PrincipalInfo
extends Object
implements org.bedework.access.Access.AccessCb, Serializable

Provide information about the current principal and given principals.

Author:

Mike Douglass douglm rpi.edu

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BwPrincipal	authPrincipal
protected String	calendarHomePath
protected org.bedework.access.PrivilegeSet	maxAllowedPrivs
protected BwPrincipal	principal
protected boolean	subscriptionsOnly
protected boolean	superUser

Constructor Summary

Constructors

Constructor	Description
PrincipalInfo(BwPrincipal principal, BwPrincipal authPrincipal, org.bedework.access.PrivilegeSet maxAllowedPrivs, boolean subscriptionsOnly)

Method Summary

Modifier and Type	Method	Description
BwPrincipal	getAuthPrincipal()
String	getCalendarHomePath()
String	getCalendarHomePath(org.bedework.access.AccessPrincipal pr)
org.bedework.access.PrivilegeSet	getMaximumAllowedPrivs()
BwPrincipal	getPrincipal()
abstract org.bedework.access.AccessPrincipal	getPrincipal(String href)
boolean	getSubscriptionsOnly()
boolean	getSuperUser()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.bedework.access.Access.AccessCb

makeHref

Field Details

superUser

protected boolean superUser

subscriptionsOnly

protected boolean subscriptionsOnly

principal

protected BwPrincipal principal

calendarHomePath

protected String calendarHomePath

authPrincipal

protected BwPrincipal authPrincipal

maxAllowedPrivs

protected org.bedework.access.PrivilegeSet maxAllowedPrivs

Constructor Details

PrincipalInfo

public PrincipalInfo(BwPrincipal principal,
 BwPrincipal authPrincipal,
 org.bedework.access.PrivilegeSet maxAllowedPrivs,
 boolean subscriptionsOnly)

Parameters:

principal - the principal

authPrincipal - the authenticated principal

maxAllowedPrivs - - used to filter access - e.g. force read only in public client

subscriptionsOnly - - true if this user is limited to internal subscriptions

Method Details

getMaximumAllowedPrivs

public org.bedework.access.PrivilegeSet getMaximumAllowedPrivs()

Returns:

max privs or null for no max

getPrincipal

public abstract org.bedework.access.AccessPrincipal getPrincipal(String href)
                                                          throws CalFacadeException

Parameters:

href - principal href

Returns:

AccessPrincipal or null for not valid

Throws:

CalFacadeException

getCalendarHomePath

public String getCalendarHomePath()

Returns:

the path for calendar home for the current principal, e.g. /user/douglm

getCalendarHomePath

public String getCalendarHomePath(org.bedework.access.AccessPrincipal pr)

Parameters:

pr - the principal

Returns:

the path for calendar home for the given principal, e.g. /user/douglm

getSuperUser

public boolean getSuperUser()

Returns:

boolean

getSubscriptionsOnly

public boolean getSubscriptionsOnly()

getPrincipal

public BwPrincipal getPrincipal()

Returns:

current principal

getAuthPrincipal

public BwPrincipal getAuthPrincipal()

Returns:

principal we authenticated as