/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2009 Sun Microsystems, Inc. All rights reserved.
* Copyright (c) Ericsson AB, 2004-2008. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.jvnet.glassfish.comms.deployment.annotations.handlers;
import java.lang.annotation.Annotation;
import java.lang.reflect.AnnotatedElement;
import java.util.logging.Level;
import org.jvnet.glassfish.comms.util.LogUtil;
import org.jvnet.glassfish.comms.deployment.backend.SipApplication;
import com.sun.enterprise.deployment.DeploymentException;
import com.sun.enterprise.deployment.annotation.AnnotationInfo;
import com.sun.enterprise.deployment.annotation.AnnotationProcessorException;
import com.sun.enterprise.deployment.annotation.HandlerProcessingResult;
import com.sun.enterprise.deployment.annotation.context.ResourceContainerContext;
/**
*
* @author Per Pettersson a.k.a. PellePedro
* @since 15-Nov-07
*
*/
public class SipApplicationHandler extends AbstractSipAnnotationHandler {
@Override
protected HandlerProcessingResult processAnnotation(
SipApplication sipApplication, AnnotationInfo ainfo,
ResourceContainerContext[] rcContexts)
throws AnnotationProcessorException
{
try {
AnnotatedElement annotatedElement = ainfo.getAnnotatedElement();
/*
* 289 PR states that one application can be registered per sar achive.
* An application is define in sip.xml or annotation package-info.java.
*
* We assume that only one sip application annotation can exist and
* the first processed taken as the SipApplication.
*
* If a sip application is defined in sip.xml, the annotation is ignored.
*/
Annotation [] annotation = annotatedElement.getAnnotations();
for (int i = 0; i < annotation.length; i++)
{
Class annotationClass = annotation[i].annotationType();
if ( annotationClass == getAnnotationType() )
{
javax.servlet.sip.annotation.SipApplication sipApplicationAnnotation =
(javax.servlet.sip.annotation.SipApplication) ainfo.getAnnotation();
// Check if Application is already defined, that is
// multiple SipApplication annotations was found
if (sipApplication.getPackageName() != null) {
return getDefaultProcessedResult();
// FIXME: uncomment to implement "only allowing one packageinfo.java" restriction.
// Must fix defect in AnnotationProcessorImpl first though so that this method
// is called only once per packageinfo.java.
// // Should result in a DeploymentException
// throw new AnnotationProcessorException("Only one packageinfo.java allowed",ainfo);
}
// Retrieve the annotated package.
// Servlets that are in the same package are part of same application.
// Alternatively servlets can specify application name.
try {
Package annotatedPackage = (Package) annotatedElement;
String annotatedPackageName = annotatedPackage.getName();
// Set package name. All servlets in this package
// belongs to the same
// Sip Application by default
sipApplication.setPackageName(annotatedPackageName);
} catch (java.lang.ClassCastException cce) {
if (theirLog.isLoggable(Level.SEVERE)) {
theirLog.log(Level.SEVERE, LOGPREFIX + "ClassCastException " +
"while processing SipApplication annotation");
}
return getDefaultFailedResult();
}
sipApplication.setAppNameFromAnnotation(sipApplicationAnnotation.name() );
sipApplication.setDescription(sipApplicationAnnotation.description());
sipApplication.setDisplayName(sipApplicationAnnotation.displayName());
sipApplication.setLargeIcon(sipApplicationAnnotation.largeIcon() );
sipApplication.setSmallIcon(sipApplicationAnnotation.smallIcon() );
if (theirLog.isLoggable(Level.INFO)) {
theirLog.log(Level.INFO, LOGPREFIX + "SipApplication annotated name is [" + sipApplicationAnnotation.name() + "]");
}
if (sipApplicationAnnotation.distributable())
{
if (theirLog.isLoggable(Level.INFO)) {
theirLog.log(Level.INFO, LOGPREFIX + "SipApplication annotated distributable" );
}
sipApplication.setDistributable(true);
}
// Main Servlet in DD overrides Annotation
if ( sipApplication.getMainservletName() == null ) {
if (!"".equals(sipApplicationAnnotation.mainServlet())) {
String mainServlet = sipApplicationAnnotation
.mainServlet();
if (theirLog.isLoggable(Level.INFO)) {
theirLog.log(Level.INFO,
LOGPREFIX
+ "SipApplication annotated mainServlet is ["
+ mainServlet + "]");
}
sipApplication.setMainservletName(mainServlet);
}
}
int sessionTimeout = sipApplicationAnnotation.sessionTimeout();
if ( sipApplication.getSessionConfigTimeout() < 1 )
{
// Not Specified
sipApplication.setSessionConfigTimeout(sessionTimeout);
if (theirLog.isLoggable(Level.INFO)) {
theirLog.log(Level.INFO, LOGPREFIX + "SipApplication annotated sessionTimeout is [" + sessionTimeout + "]. This value can be changed in sip.xml ");
}
} else {
if (theirLog.isLoggable(Level.INFO)) {
theirLog.log(Level.INFO, LOGPREFIX + "SipApplication sessionTimeout [" + sipApplication.getSessionConfigTimeout() + "]. This value was specified in sip.xml");
}
}
int proxyTimeout = sipApplicationAnnotation.proxyTimeout();
if ( sipApplication.getProxyConfigSequentialSearchTimeout() == 0 )
{
// Not Specified
sipApplication.setProxyConfigSequentialSearchTimeout(proxyTimeout);
if (theirLog.isLoggable(Level.INFO)) {
theirLog.log(Level.INFO, LOGPREFIX + "SipApplication annotated proxyTimeout is [" + sessionTimeout + "]. This value can be changed in sip.xml");
}
} else {
if (theirLog.isLoggable(Level.INFO)) {
theirLog.log(Level.INFO, LOGPREFIX + "SipApplication proxyTimeout [" + sipApplication.getProxyConfigSequentialSearchTimeout() +
"]. This value was specified in sip.xml");
}
}
}
}
} catch (Exception e) {
if (theirLog.isLoggable(Level.INFO)) {
theirLog.log(Level.INFO, LOGPREFIX + "Exception at annotation processing");
}
if(e instanceof AnnotationProcessorException){
throw (AnnotationProcessorException)e;
}
return getDefaultFailedResult();
}
return getDefaultProcessedResult();
}
public Class<? extends Annotation> getAnnotationType()
{
return javax.servlet.sip.annotation.SipApplication.class;
}
}