/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.apache.myfaces.extensions.cdi.jsf.impl.config.view;
import org.apache.myfaces.extensions.cdi.core.api.config.view.ViewConfig;
import org.apache.myfaces.extensions.cdi.core.api.config.view.ViewMetaData;
import org.apache.myfaces.extensions.cdi.core.api.config.view.DefaultErrorView;
import org.apache.myfaces.extensions.cdi.core.api.security.Secured;
import org.apache.myfaces.extensions.cdi.jsf.api.config.view.Page;
import org.apache.myfaces.extensions.cdi.jsf.api.config.view.ViewConfigDescriptor;
import org.apache.myfaces.extensions.cdi.jsf.impl.config.view.spi.EditableViewConfigDescriptor;
import org.apache.myfaces.extensions.cdi.jsf.impl.config.view.spi.ViewConfigExtractor;
import javax.inject.Named;
import java.lang.annotation.Annotation;
import java.util.List;
import java.util.ArrayList;
import java.util.Collection;
import static org.apache.myfaces.extensions.cdi.jsf.impl.util.ExceptionUtils.missingInlineViewConfigRootMarkerException;
/**
* @author Gerhard Petracek
*/
class DefaultViewConfigExtractor implements ViewConfigExtractor
{
private static final long serialVersionUID = 5794817257216134993L;
/**
* {@inheritDoc}
*/
public EditableViewConfigDescriptor extractViewConfig(Class<? extends ViewConfig> viewDefinitionClass)
{
//use the interface to make clear which information we really need
ViewConfigDescriptor viewConfigDescriptor = new ExtractedViewConfigDefinitionEntry(viewDefinitionClass);
return extractViewConfigDescriptor(viewDefinitionClass, viewConfigDescriptor);
}
/**
* {@inheritDoc}
*/
public boolean isInlineViewConfig(Class<? extends ViewConfig> viewDefinitionClass)
{
return isResolvable(viewDefinitionClass, new ArrayList<Class<? extends Annotation>>());
}
/**
* {@inheritDoc}
*/
public EditableViewConfigDescriptor extractInlineViewConfig(Class<? extends ViewConfig> viewDefinitionClass)
{
Class viewConfigRootMarker = ViewConfigCache.getInlineViewConfigRootMarker();
if(viewConfigRootMarker == null)
{
throw missingInlineViewConfigRootMarkerException(viewDefinitionClass);
}
int startIndex = viewConfigRootMarker.getPackage().getName().length() + 1;
int endIndex = viewDefinitionClass.getName().lastIndexOf(".");
String basePath;
if(startIndex < endIndex)
{
basePath = viewDefinitionClass.getName()
.substring(startIndex, endIndex);
basePath = basePath.replace(".", "/");
}
else
{
basePath = null; //both are in the same package
}
//use the interface to make clear which information we really need
ViewConfigDescriptor viewConfigDescriptor =
new ExtractedInlineViewConfigDefinitionEntry(viewDefinitionClass, basePath);
return extractViewConfigDescriptor(viewDefinitionClass, viewConfigDescriptor);
}
private EditableViewConfigDescriptor extractViewConfigDescriptor(Class<? extends ViewConfig> viewDefinitionClass,
ViewConfigDescriptor viewConfigDescriptor)
{
scanViewConfigClass(viewDefinitionClass, (ExtractedViewConfigDefinitionEntry)viewConfigDescriptor);
Class<? extends ViewConfig> errorView = null;
Page.ViewParameterMode viewParameterMode = Page.ViewParameterMode.DEFAULT;
if(viewConfigDescriptor instanceof EditableViewConfigDescriptor)
{
errorView = ((EditableViewConfigDescriptor)viewConfigDescriptor).getErrorView();
viewParameterMode = ((EditableViewConfigDescriptor)viewConfigDescriptor).getViewParameterMode();
}
return new DefaultViewConfigDescriptor(viewConfigDescriptor.getViewId(),
viewDefinitionClass,
viewConfigDescriptor.getNavigationMode(),
viewParameterMode,
viewConfigDescriptor.getAccessDecisionVoters(),
errorView,
viewConfigDescriptor.getMetaData());
}
private Collection<Annotation> extractViewMetaData(
Class<?> targetClass, ExtractedViewConfigDefinitionEntry entry)
{
List<Annotation> result = new ArrayList<Annotation>();
for(Annotation annotation : targetClass.getAnnotations())
{
if(annotation.annotationType().isAnnotationPresent(ViewMetaData.class))
{
ViewMetaData metaData = annotation.annotationType().getAnnotation(ViewMetaData.class);
if(!entry.getFoundAndBlockedMetaDataTypes().contains(annotation.annotationType()))
{
result.add(annotation);
if(metaData.override())
{
entry.blockMetaData(annotation.annotationType());
}
}
}
}
return result;
}
private void scanViewConfigClass(Class<?> viewDefinitionClass, ExtractedViewConfigDefinitionEntry scannedViewConfig)
{
String defaultExtension = ExtractedViewConfigDefinitionEntry.DEFAULT_EXTENSION;
String defaultPageName = ExtractedViewConfigDefinitionEntry.DEFAULT_PAGE_NAME;
String rootPath = ExtractedViewConfigDefinitionEntry.ROOT_PATH;
String currentBasePath;
Page pageAnnotation;
Secured securedAnnotation;
Class<?> currentClass = viewDefinitionClass;
while (currentClass != null && !Object.class.getName().equals(currentClass.getName()))
{
//security
if (currentClass.isAnnotationPresent(Secured.class))
{
securedAnnotation = currentClass.getAnnotation(Secured.class);
scannedViewConfig.addAccessDecisionVoters(securedAnnotation.value());
if (scannedViewConfig.getErrorView() == null &&
!DefaultErrorView.class.getName().equals(securedAnnotation.errorView().getName()))
{
scannedViewConfig.setErrorView(securedAnnotation.errorView());
}
}
//meta-data
scannedViewConfig.addMetaData(
extractViewMetaData(currentClass, scannedViewConfig));
//page definition
if (currentClass.isAnnotationPresent(Page.class))
{
pageAnnotation = currentClass.getAnnotation(Page.class);
if (!pageAnnotation.extension().equals(defaultExtension))
{
scannedViewConfig.setExtension(pageAnnotation.extension());
}
if (!pageAnnotation.basePath().equals(rootPath))
{
currentBasePath = pageAnnotation.basePath();
if (!".".equals(currentBasePath))
{
scannedViewConfig
.setSimpleClassNameToPathMapping(currentClass.getSimpleName(), currentBasePath);
}
if (rootPath.equals(scannedViewConfig.getBasePath()))
{
scannedViewConfig.setBasePath(currentBasePath);
}
}
if (!scannedViewConfig.isKnownNavigationMode() &&
!pageAnnotation.navigation().equals(Page.NavigationMode.DEFAULT))
{
scannedViewConfig.setNavigationMode(pageAnnotation.navigation());
}
if (!scannedViewConfig.isKnownViewParameterMode() &&
!pageAnnotation.viewParams().equals(Page.ViewParameterMode.DEFAULT))
{
scannedViewConfig.setViewParameterMode(pageAnnotation.viewParams());
}
if (!pageAnnotation.name().equals(defaultPageName))
{
scannedViewConfig.setPageName(pageAnnotation.name());
}
}
//scan interfaces
for(Class interfaceClass : currentClass.getInterfaces())
{
scanViewConfigClass(interfaceClass, scannedViewConfig);
}
//scan super class
currentClass = currentClass.getSuperclass();
}
}
/**
* @param annotated current class to scan
* @param scannedAnnotations simple cycle prevention
* @return true to signal that the class is resolvable via EL
*/
private boolean isResolvable(Class annotated, List<Class<? extends Annotation>> scannedAnnotations)
{
if(annotated.isAnnotation())
{
scannedAnnotations.add(annotated);
}
Class<? extends Annotation> annotationClass;
for(Annotation annotation : annotated.getAnnotations())
{
annotationClass = annotation.annotationType();
if(scannedAnnotations.contains(annotationClass))
{
continue;
}
if(Named.class.equals(annotationClass) || "javax.faces.bean.ManagedBean".equals(annotationClass.getName()))
{
return true;
}
//to support stereotypes
if(isResolvable(annotationClass, scannedAnnotations))
{
return true;
}
}
return false;
}
}