org.acegisecurity.ui.cas.ServiceProperties Maven / Gradle / Ivy
/* Copyright 2004 Acegi Technology Pty Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.acegisecurity.ui.cas;
import org.springframework.beans.factory.InitializingBean;
/**
* Stores properties related to this CAS service.
*
*
* Each web application capable of processing CAS tickets is known as a
* service. This class stores the properties that are relevant to the local
* CAS service, being the application that is being secured by the Acegi
* Security System for Spring.
*
*
* @author Ben Alex
* @version $Id: ServiceProperties.java,v 1.3 2005/11/17 00:55:49 benalex Exp $
*/
public class ServiceProperties implements InitializingBean {
//~ Instance fields ========================================================
private String service;
private boolean sendRenew = false;
//~ Methods ================================================================
public void setSendRenew(boolean sendRenew) {
this.sendRenew = sendRenew;
}
/**
* Indicates whether the renew parameter should be sent to the
* CAS login URL and CAS validation URL.
*
*
* If true, it will force CAS to authenticate the user again
* (even if the user has previously authenticated). During ticket
* validation it will require the ticket was generated as a consequence of
* an explicit login. High security applications would probably set this
* to true. Defaults to false, providing
* automated single sign on.
*
*
* @return whether to send the renew parameter to CAS
*/
public boolean isSendRenew() {
return sendRenew;
}
public void setService(String service) {
this.service = service;
}
/**
* Represents the service the user is authenticating to.
*
*
* This service is the callback URL belonging to the local Acegi Security
* System for Spring secured application. For example,
*
* https://www.mycompany.com/application/j_acegi_cas_security_check
*
* @return the URL of the service the user is authenticating to
*/
public String getService() {
return service;
}
public void afterPropertiesSet() throws Exception {
if ((service == null) || "".equals(service)) {
throw new IllegalArgumentException("service must be specified");
}
}
}