org.mobicents.as7.deployment.SipAnnotationDeploymentProcessor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jboss-as7-restcomm Show documentation
Show all versions of jboss-as7-restcomm Show documentation
>JBoss Application Server: Restcomm Sip Servlets Adaptation Layer
/*
* TeleStax, Open Source Cloud Communications
* Copyright 2011-2014, Telestax Inc and individual contributors
* by the @authors tag.
*
* This program is free software: you can redistribute it and/or modify
* under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation; either version 3 of
* the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see indexes = AnnotationIndexUtils.getAnnotationIndexes(deploymentUnit);
// Process components
for (final Entry entry : indexes.entrySet()) {
if (logger.isDebugEnabled()) logger.debug("doDeploy(): processing annotations from " + entry.getKey().getRootName());
final Index jarIndex = entry.getValue();
SipMetaData sipMetaData = processAnnotations(sipAnnotationsMetaData, jarIndex);
if(sipMetaData != null) {
// https://github.com/Mobicents/sip-servlets/issues/68 Adding only the ones that actually have annotations
// to save memory and computing time later on
sipAnnotationsMetaData.put(entry.getKey().getRootName(), sipMetaData);
}
}
}
/**
* Process a single index.
*
* @param index the annotation index
* @throws DeploymentUnitProcessingException
*/
protected SipMetaData processAnnotations(SipAnnotationMetaData sipAnotationsMetaData, Index index) throws DeploymentUnitProcessingException {
Sip11MetaData sipMetaData = null;
// @SipListener
final List sipListenerAnnotations = index.getAnnotations(sipListener);
if (sipListenerAnnotations != null && sipListenerAnnotations.size() > 0) {
sipMetaData = new Sip11MetaData();
List listeners = new ArrayList();
for (final AnnotationInstance annotation : sipListenerAnnotations) {
if (logger.isDebugEnabled()) logger.debug("processAnnotations(): @SipListener: " + annotation);
ListenerMetaData listener = new ListenerMetaData();
AnnotationTarget target = annotation.target();
if (!(target instanceof ClassInfo)) {
throw new DeploymentUnitProcessingException("@SipListener is only allowed at class level " + target);
}
ClassInfo classInfo = ClassInfo.class.cast(target);
listener.setListenerClass(classInfo.toString());
AnnotationValue descriptionValue = annotation.value();
if (descriptionValue != null) {
DescriptionGroupMetaData descriptionGroup = getDescriptionGroup(descriptionValue.asString());
if (descriptionGroup != null) {
listener.setDescriptionGroup(descriptionGroup);
}
}
for (AnnotationValue value: annotation.values()) {
if (value.name().compareTo("name") == 0) {
// listener name not supported
//listener.setName(value.asString());
}
else if (value.name().compareTo("applicationName") == 0) {
if (sipMetaData.getApplicationName() == null) {
sipMetaData.setApplicationName(value.asString());
}
else if ((sipMetaData.getApplicationName() != null) && (sipMetaData.getApplicationName().compareTo(value.asString()) != 0)) {
throw (new DeploymentUnitProcessingException("Sip Application Name mismatch: already loaded: " + sipMetaData.getApplicationName() + " - from @SipListener annotation (" + listener.getListenerClass() + "): " + value.asString()));
}
}
}
if (logger.isDebugEnabled()) logger.debug("processAnnotations(): sipListener added " + listener);
listeners.add(listener);
}
if (logger.isDebugEnabled()) logger.debug("processAnnotations(): " + listeners.size() + " sipListeners added");
sipMetaData.setListeners(listeners);
}
// @SipServlet
final List sipServletAnnotations = index.getAnnotations(sipServlet);
if (sipServletAnnotations != null && sipServletAnnotations.size() > 0) {
if(sipMetaData == null) {
sipMetaData = new Sip11MetaData();
}
SipServletsMetaData sipServlets = new SipServletsMetaData();
// @SipApplication
final List sipApplicationAnnotations = index.getAnnotations(sipApplication);
boolean sipApplicationPresent = false;
String parsedAnnotatedPackage = null;
if (sipApplicationAnnotations != null && sipApplicationAnnotations.size() > 0) {
sipApplicationPresent = true;
}
for (final AnnotationInstance annotation : sipServletAnnotations) {
if (logger.isDebugEnabled()) logger.debug("processAnnotations(): @SipServlet: " + annotation);
ServletMetaData servlet = new ServletMetaData();
AnnotationTarget target = annotation.target();
if (!(target instanceof ClassInfo)) {
throw new DeploymentUnitProcessingException("@SipServlet is only allowed at class level " + target);
}
ClassInfo classInfo = ClassInfo.class.cast(target);
servlet.setServletClass(classInfo.toString());
AnnotationValue descriptionValue = annotation.value();
if (descriptionValue != null) {
DescriptionGroupMetaData descriptionGroup = getDescriptionGroup(descriptionValue.asString());
if (descriptionGroup != null) {
servlet.setDescriptionGroup(descriptionGroup);
}
}
for (AnnotationValue value: annotation.values()) {
if (value.name().compareTo("name") == 0) {
servlet.setName(value.asString());
}
else if (value.name().compareTo("loadOnStartup") == 0) {
servlet.setLoadOnStartup(value.asString());
}
else if (value.name().compareTo("applicationName") == 0) {
if (sipMetaData.getApplicationName() == null) {
sipMetaData.setApplicationName(value.asString());
}
else if ((sipMetaData.getApplicationName() != null) && (sipMetaData.getApplicationName().compareTo(value.asString()) != 0)) {
throw (new DeploymentUnitProcessingException("Sip Application Name mismatch: already loaded: " + sipMetaData.getApplicationName() + " - from @SipServlet annotation (" + servlet.getServletClass() + "): " + value.asString()));
}
}
}
if (servlet.getName() == null) {
// must have a name
servlet.setName(servlet.getServletClass());
}
if (sipApplicationPresent) {
sipAnotationsMetaData.setSipApplicationAnnotationPresent(true);
AnnotationInstance sipAppAnnotation = sipApplicationAnnotations.get(0);
if (logger.isDebugEnabled()) logger.debug("processAnnotations(): @SipAnnotation: " + annotation);
AnnotationTarget sipAppTarget = sipAppAnnotation.target();
if (!(target instanceof ClassInfo)) {
throw new DeploymentUnitProcessingException("@SipAnnotation is only allowed at class level " + target);
}
ClassInfo sipAppClassInfo = ClassInfo.class.cast(sipAppTarget);
String packageName = sipAppClassInfo.toString().substring(0,sipAppClassInfo.toString().lastIndexOf('.'));
if (parsedAnnotatedPackage != null && !parsedAnnotatedPackage.equals(packageName)) {
throw new DeploymentUnitProcessingException("Cant have two different applications in a single context - " + packageName + " and " + parsedAnnotatedPackage);
}
if (parsedAnnotatedPackage == null) {
parsedAnnotatedPackage = packageName;
parseSipApplication(sipMetaData,sipAppAnnotation, packageName);
}
}
if (logger.isDebugEnabled()) logger.debug("processAnnotations(): sipServlet added " + servlet);
sipServlets.add(servlet);
}
if (logger.isDebugEnabled()) logger.debug("processAnnotations(): " + sipServlets.size() + " sipServlets added");
sipMetaData.setSipServlets(sipServlets);
}
//@SipApplicationKey
final List sipApplicationKeyAnnotations = index.getAnnotations(sipApplicationKey);
if (sipApplicationKeyAnnotations != null && sipApplicationKeyAnnotations.size() > 0) {
if(sipMetaData == null) {
sipMetaData = new Sip11MetaData();
}
for (final AnnotationInstance annotation : sipApplicationKeyAnnotations) {
if (logger.isDebugEnabled()) logger.debug("processAnnotations(): @SipApplicationKey: " + annotation);
final AnnotationTarget target = annotation.target();
if (!(target instanceof MethodInfo)) {
throw new DeploymentUnitProcessingException("@SipApplicationKey is only allowed at method level " + target);
}
final MethodInfo methodInfo = MethodInfo.class.cast(target);
if(!Modifier.isStatic(methodInfo.flags()) || !Modifier.isPublic(methodInfo.flags())) {
throw new DeploymentUnitProcessingException("A method annotated with the @SipApplicationKey annotation MUST be public and static");
}
if(!methodInfo.returnType().name().toString().equals(String.class.getName())) {
throw new DeploymentUnitProcessingException("A method annotated with the @SipApplicationKey annotation MUST return a String");
}
final Type[] types = methodInfo.args();
if(types.length != 1 || !types[0].name().toString().equals(SipServletRequest.class.getName())) {
throw new DeploymentUnitProcessingException("A method annotated with the @SipApplicationKey annotation MUST have a single argument of type SipServletRequest");
}
if(sipMetaData.getSipApplicationKeyMethodInfo() != null && !sipMetaData.getSipApplicationKeyMethodInfo().equals(methodInfo)) {
// https://code.google.com/p/sipservlets/issues/detail?id=37
throw new DeploymentUnitProcessingException("More than one SipApplicationKey annotated method is not allowed.");
}
final SipApplicationKeyMethodInfo sipApplicationKeyMethodInfo = new SipApplicationKeyMethodInfo(methodInfo.declaringClass().name().toString(), methodInfo.name());
sipMetaData.setSipApplicationKeyMethodInfo(sipApplicationKeyMethodInfo);
if (logger.isDebugEnabled()) logger.debug("processAnnotations(): added " + sipApplicationKeyMethodInfo + " as @SipApplicationKey method");
}
}
//@ConcurrencyControl
final List concurrencyControlAnnotations = index.getAnnotations(concurrencyControl);
if (concurrencyControlAnnotations != null && concurrencyControlAnnotations.size() > 0) {
if(sipMetaData == null) {
sipMetaData = new Sip11MetaData();
}
for (final AnnotationInstance annotation : concurrencyControlAnnotations) {
if (logger.isDebugEnabled()) logger.debug("processAnnotations(): @ConcurrencyControl: " + annotation);
final AnnotationTarget target = annotation.target();
if (!(target instanceof ClassInfo)) {
throw new DeploymentUnitProcessingException("@ConcurrencyControl is only allowed at package level " + target);
}
ConcurrencyControlMode mode = ConcurrencyControlMode.valueOf(annotation.value("mode").asString());
sipMetaData.setConcurrencyControlMode(mode);
if (logger.isDebugEnabled()) logger.debug("processAnnotations(): ConcurrencyControl set to " + mode);
}
}
return sipMetaData;
}
protected Descriptions getDescription(String description) {
DescriptionsImpl descriptions = null;
if (description.length() > 0) {
DescriptionImpl di = new DescriptionImpl();
di.setDescription(description);
descriptions = new DescriptionsImpl();
descriptions.add(di);
}
return descriptions;
}
protected DisplayNames getDisplayName(String displayName) {
DisplayNamesImpl displayNames = null;
if (displayName.length() > 0) {
DisplayNameImpl dn = new DisplayNameImpl();
dn.setDisplayName(displayName);
displayNames = new DisplayNamesImpl();
displayNames.add(dn);
}
return displayNames;
}
protected Icons getIcons(String smallIcon, String largeIcon) {
IconsImpl icons = null;
if (smallIcon.length() > 0 || largeIcon.length() > 0) {
IconImpl i = new IconImpl();
i.setSmallIcon(smallIcon);
i.setLargeIcon(largeIcon);
icons = new IconsImpl();
icons.add(i);
}
return icons;
}
protected DescriptionGroupMetaData getDescriptionGroup(String description) {
DescriptionGroupMetaData dg = null;
if (description.length() > 0) {
dg = new DescriptionGroupMetaData();
Descriptions descriptions = getDescription(description);
dg.setDescriptions(descriptions);
}
return dg;
}
protected DescriptionGroupMetaData getDescriptionGroup(String description, String displayName, String smallIcon,
String largeIcon) {
DescriptionGroupMetaData dg = null;
if (description.length() > 0 || displayName.length() > 0 || smallIcon.length() > 0 || largeIcon.length() > 0) {
dg = new DescriptionGroupMetaData();
Descriptions descriptions = getDescription(description);
if (descriptions != null)
dg.setDescriptions(descriptions);
DisplayNames displayNames = getDisplayName(displayName);
if (displayNames != null)
dg.setDisplayNames(displayNames);
Icons icons = getIcons(smallIcon, largeIcon);
if (icons != null)
dg.setIcons(icons);
}
return dg;
}
private static SipApplication getApplicationAnnotation(Package pack) {
if(pack == null) return null;
SipApplication sipApp = (SipApplication) pack.getAnnotation(SipApplication.class);
if(sipApp != null) {
return sipApp;
}
return null;
}
private void parseSipApplication(SipMetaData sipMetaData, AnnotationInstance sipAppAnnInstance, String packageName) throws DeploymentUnitProcessingException {
String description = null;
String displayName = null;
String largeIcon = null;
String smallIcon = null;
for (AnnotationValue value: sipAppAnnInstance.values()) {
// application name
if (value.name().compareTo("name") == 0) {
if (sipMetaData.getApplicationName() == null) {
if (logger.isDebugEnabled()) logger.debug("parseSipApplication(): @SipApplication: " + value.asString());
sipMetaData.setApplicationName(value.asString());
}
else if ((sipMetaData.getApplicationName() != null) && (sipMetaData.getApplicationName().compareTo(value.asString()) != 0)) {
throw (new DeploymentUnitProcessingException("Sip Application Name mismatch! Already defined: " + sipMetaData.getApplicationName() + " - from @SipAnnotation (package " + packageName + "): " + value.asString()));
}
}
// description
else if (value.name().compareTo("description") == 0) {
DescriptionImpl di = new DescriptionImpl();
di.setDescription(value.asString());
getOrCreateDs(getOrCreateDG(sipMetaData)).add(di);
}
// display name
else if (value.name().compareTo("displayName") == 0) {
DisplayNameImpl dn = new DisplayNameImpl();
dn.setDisplayName(value.asString());
getOrCreateDn(getOrCreateDG(sipMetaData)).add(dn);
}
// distributable
else if (value.name().compareTo("distributable") == 0) {
throw (new DeploymentUnitProcessingException("Distributable not supported yet"));
// sipMetaData.setDistributable(new EmptyMetaData());
}
// large icon
else if (value.name().compareTo("largeIcon") == 0) {
largeIcon = value.asString();
}
// small icon
else if (value.name().compareTo("smallIcon") == 0) {
smallIcon = value.asString();
}
else if (value.name().compareTo("mainServlet") == 0) {
if (sipMetaData.getServletSelection() == null) {
sipMetaData.setServletSelection(new SipServletSelectionMetaData());
}
sipMetaData.getServletSelection().setMainServlet(value.asString());
}
else if (value.name().compareTo("proxyTimeout") == 0) {
if(sipMetaData.getProxyConfig() == null) {
sipMetaData.setProxyConfig(new ProxyConfigMetaData());
}
sipMetaData.getProxyConfig().setProxyTimeout(value.asInt());
}
else if (value.name().compareTo("sessionTimeout") == 0) {
if(sipMetaData.getSessionConfig() == null) {
sipMetaData.setSessionConfig(new SessionConfigMetaData());
}
sipMetaData.getSessionConfig().setSessionTimeout(value.asInt());
}
}
if (smallIcon != null || largeIcon != null) {
IconImpl icon = new IconImpl();
if (smallIcon != null)
icon.setSmallIcon(smallIcon);
if (largeIcon != null)
icon.setLargeIcon(largeIcon);
getOrCreateIs(getOrCreateDG(sipMetaData)).add(icon);
}
if (sipMetaData.getApplicationName() == null) {
if (logger.isDebugEnabled()) logger.debug("parseSipApplication(): @SipApplication: " + packageName);
sipMetaData.setApplicationName(packageName);
}
}
private static DescriptionGroupMetaData getOrCreateDG(SipMetaData sipMetaData) {
DescriptionGroupMetaData dg = sipMetaData.getDescriptionGroup();
if (dg == null) {
dg = new DescriptionGroupMetaData();
sipMetaData.setDescriptionGroup(dg);
}
return dg;
}
private static DescriptionsImpl getOrCreateDs(DescriptionGroupMetaData dg) {
DescriptionsImpl ds = (DescriptionsImpl) dg.getDescriptions();
if (ds == null) {
ds = new DescriptionsImpl();
dg.setDescriptions(ds);
}
return ds;
}
private static DisplayNamesImpl getOrCreateDn(DescriptionGroupMetaData dg) {
DisplayNamesImpl dn = (DisplayNamesImpl) dg.getDisplayNames();
if (dn == null) {
dn = new DisplayNamesImpl();
dg.setDisplayNames(dn);
}
return dn;
}
private static IconsImpl getOrCreateIs(DescriptionGroupMetaData dg) {
IconsImpl ii = (IconsImpl) dg.getIcons();
if (ii == null) {
ii = new IconsImpl();
dg.setIcons(ii);
}
return ii;
}
static final String SIP_XML = "WEB-INF/sip.xml";
protected boolean canHandle(DeploymentUnit deploymentUnit) {
//return DeploymentTypeMarker.isType(DeploymentType.WAR, deploymentUnit);
final ResourceRoot deploymentRoot = deploymentUnit.getAttachment(Attachments.DEPLOYMENT_ROOT);
final VirtualFile sipXml = deploymentRoot.getRoot().getChild(SIP_XML);
if (DeploymentTypeMarker.isType(DeploymentType.WAR, deploymentUnit) && sipXml.exists()) {
return true;
}
return false;
}
@Override
public void undeploy(DeploymentUnit context) {
// TODO Auto-generated method stub
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy