AuthTag (Nuxeo 2021.1.19 API Documentation)

java.lang.Object
- javax.servlet.jsp.tagext.TagSupport
- - edu.yale.its.tp.cas.client.taglib.AuthTag

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
```
public class AuthTag
extends javax.servlet.jsp.tagext.TagSupport
```
Authentication tag for use with the Yale Central Authentication Service.

Typical usage involves placing the tag at the top of the page. The tag checks to determine if the attribute referenced by id/scope exists; if it does, the tag has no runtime effect. If the attribute does not exist, however, a CAS authentication is necessary: if no ticket is present, we redirect to CAS, and if a ticket is present, we validate it. Upon successful CAS authentication (either by a pre-existing attribute or through CAS directly), we store the NetID in the attribute referenced by id/scope.

Author:

Shawn Bayern, Drew Mazurek

See Also:

Serialized Form

Field Summary
- Fields inherited from class javax.servlet.jsp.tagext.TagSupport
  id, pageContext
- Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
  EVAL_BODY_AGAIN
- Fields inherited from interface javax.servlet.jsp.tagext.Tag
  EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors
Constructor Description

AuthTag()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addAuthorizedProxy(String proxyId)`
`int`	`doEndTag()`
`int`	`doStartTag()`
`void`	`release()`
`void`	`setCasLogin(String url)`
`void`	`setCasValidate(String url)`
`void`	`setScope(String scope)`
`void`	`setService(String service)`
`void`	`setVar(String var)`

Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AuthTag
```
public AuthTag()
```
- Method Detail
  - doStartTag
```
public int doStartTag()
               throws javax.servlet.jsp.JspException
```
    Specified by:
    
    doStartTag in interface javax.servlet.jsp.tagext.Tag
    
    Overrides:
    
    doStartTag in class javax.servlet.jsp.tagext.TagSupport
    
    Throws:
    
    javax.servlet.jsp.JspException
  - doEndTag
```
public int doEndTag()
             throws javax.servlet.jsp.JspTagException
```
    Specified by:
    
    doEndTag in interface javax.servlet.jsp.tagext.Tag
    
    Overrides:
    
    doEndTag in class javax.servlet.jsp.tagext.TagSupport
    
    Throws:
    
    javax.servlet.jsp.JspTagException
  - setVar
```
public void setVar(String var)
```
  - setScope
```
public void setScope(String scope)
```
  - setCasLogin
```
public void setCasLogin(String url)
```
  - setCasValidate
```
public void setCasValidate(String url)
```
  - addAuthorizedProxy
```
public void addAuthorizedProxy(String proxyId)
```
  - setService
```
public void setService(String service)
```
  - release
```
public void release()
```
    Specified by:
    
    release in interface javax.servlet.jsp.tagext.Tag
    
    Overrides:
    
    release in class javax.servlet.jsp.tagext.TagSupport