classes) {
/**
* Let some plugins route themself
+ *
* @param request
+ * the current request
*/
public void routeRequest(Request request) {
}
+ /**
+ * @param modelClass
+ * class of the model
+ * @return the Model factory
+ */
public Model.Factory modelFactory(Class modelClass) {
return null;
}
@@ -320,6 +430,11 @@ public void afterFixtureLoad() {
/**
* Inter-plugin communication.
+ *
+ * @param message
+ * the message to post
+ * @param context
+ * an object
*/
public static void postEvent(String message, Object context) {
Play.pluginCollection.onEvent(message, context);
@@ -362,14 +477,14 @@ public Object willBeValidated(Object value) {
}
/**
- * Implement to add some classes that should be considered unit tests but do not extend
- * {@link org.junit.Assert} to tests that can be executed by test runner (will be visible in test UI).
+ * Implement to add some classes that should be considered unit tests but do not extend {@link org.junit.Assert} to
+ * tests that can be executed by test runner (will be visible in test UI).
*
* Note:You probably will also need to override {@link PlayPlugin#runTest(java.lang.Class)} method
* to handle unsupported tests execution properly.
*
- * Keep in mind that this method can only add tests to currently loaded ones.
- * You cannot disable tests this way. You should also make sure you do not duplicate already loaded tests.
+ * Keep in mind that this method can only add tests to currently loaded ones. You cannot disable tests this way. You
+ * should also make sure you do not duplicate already loaded tests.
*
* @return list of plugin supported unit test classes (empty list in default implementation)
*/
@@ -384,8 +499,8 @@ public Collection getUnitTests() {
* Note:You probably will also need to override {@link PlayPlugin#runTest(java.lang.Class)} method
* to handle unsupported tests execution properly.
*
- * Keep in mind that this method can only add tests to currently loaded ones.
- * You cannot disable tests this way. You should also make sure you do not duplicate already loaded tests.
+ * Keep in mind that this method can only add tests to currently loaded ones. You cannot disable tests this way. You
+ * should also make sure you do not duplicate already loaded tests.
*
* @return list of plugin supported functional test classes (empty list in default implementation)
*/
@@ -393,78 +508,82 @@ public Collection getFunctionalTests() {
return emptyList();
}
- /**
- * Class that define a filter. A filter is a class that wrap a certain behavior around an action.
- * You can access your Request and Response object within the filter. See the JPA plugin for an example.
- * The JPA plugin wraps a transaction around an action. The filter applies a transaction to the current Action.
+ /**
+ * Class that define a filter. A filter is a class that wrap a certain behavior around an action. You can access
+ * your Request and Response object within the filter. See the JPA plugin for an example. The JPA plugin wraps a
+ * transaction around an action. The filter applies a transaction to the current Action.
*/
- public abstract static class Filter
- {
+ public abstract static class Filter {
String name;
public Filter(String name) {
this.name = name;
}
-
+
public abstract T withinFilter(play.libs.F.Function0 fct) throws Throwable;
/**
- * Surround innerFilter with this. (innerFilter after this)
- * @param innerFilter filter to be wrapped.
- * @return a new Filter object. newFilter.withinFilter(x) is outerFilter.withinFilter(innerFilter.withinFilter(x))
+ * Surround innerFilter with this. (innerFilter after this)
+ *
+ * @param innerFilter
+ * filter to be wrapped.
+ * @return a new Filter object. newFilter.withinFilter(x) is
+ * outerFilter.withinFilter(innerFilter.withinFilter(x))
*/
public Filter decorate(final Filter innerFilter) {
- final Filter outerFilter = this;
- return new Filter(this.name) {
- @Override
- public T withinFilter(F.Function0 fct) throws Throwable {
- return compose(outerFilter.asFunction(), innerFilter.asFunction()).apply(fct);
- }
- };
+ final Filter outerFilter = this;
+ return new Filter(this.name) {
+ @Override
+ public T withinFilter(F.Function0 fct) throws Throwable {
+ return compose(outerFilter.asFunction(), innerFilter.asFunction()).apply(fct);
+ }
+ };
}
/**
* Compose two second order functions whose input is a zero param function that returns type T...
- * @param outer Function that will wrap inner -- ("outer after inner")
- * @param inner Function to be wrapped by outer function -- ("outer after inner")
- * @return A function that computes outer(inner(x)) on application.
+ *
+ * @param outer
+ * Function that will wrap inner -- ("outer after inner")
+ * @param inner
+ * Function to be wrapped by outer function -- ("outer after inner")
+ * @return A function that computes outer(inner(x)) on application.
*/
- private static Function1, T> compose(final Function1, T> outer, final Function1, T> inner) {
-
- return
- new Function1, T>() {
- @Override
- public T apply(final F.Function0 arg) throws Throwable {
- return outer.apply(new F.Function0() {
- @Override
- public T apply() throws Throwable {
- return inner.apply(arg);
- }
- });
- }
- };
+ private static Function1, T> compose(final Function1, T> outer,
+ final Function1, T> inner) {
+
+ return new Function1, T>() {
+ @Override
+ public T apply(final F.Function0 arg) throws Throwable {
+ return outer.apply(new F.Function0() {
+ @Override
+ public T apply() throws Throwable {
+ return inner.apply(arg);
+ }
+ });
+ }
+ };
}
-
private final Function1, T> _asFunction = new Function1, T>() {
- @Override
- public T apply(F.Function0 arg) throws Throwable {
- return withinFilter(arg);
- }
+ @Override
+ public T apply(F.Function0 arg) throws Throwable {
+ return withinFilter(arg);
+ }
};
public Function1, T> asFunction() {
- return _asFunction;
+ return _asFunction;
}
public String getName() {
return name;
}
- //I don't want to add any additional dependencies to the project or use JDK 8 features
- //so I'm just rolling my own 1 arg function interface... there must be a better way to do this...
+ // I don't want to add any additional dependencies to the project or use JDK 8 features
+ // so I'm just rolling my own 1 arg function interface... there must be a better way to do this...
public static interface Function1 {
- public O apply(I arg) throws Throwable;
+ public O apply(I arg) throws Throwable;
}
}
@@ -473,11 +592,12 @@ public final boolean hasFilter() {
}
/**
- * Return the filter implementation for this plugin.
- */
+ * Return the filter implementation for this plugin.
+ *
+ * @return filter object of this plugin
+ */
public Filter getFilter() {
return null;
}
-
}
diff --git a/framework/src/play/classloading/ApplicationClasses.java b/framework/src/play/classloading/ApplicationClasses.java
index cc3cd9b03b..966961243a 100644
--- a/framework/src/play/classloading/ApplicationClasses.java
+++ b/framework/src/play/classloading/ApplicationClasses.java
@@ -123,6 +123,9 @@ public List all() {
/**
* Put a new class to the cache.
+ *
+ * @param applicationClass
+ * The class to add
*/
public void add(ApplicationClass applicationClass) {
classes.put(applicationClass.name, applicationClass);
@@ -130,11 +133,20 @@ public void add(ApplicationClass applicationClass) {
/**
* Remove a class from cache
+ *
+ * @param applicationClass
+ * The class to remove
*/
public void remove(ApplicationClass applicationClass) {
classes.remove(applicationClass.name);
}
+ /**
+ * Remove a class from cache
+ *
+ * @param applicationClass
+ * The class name to remove
+ */
public void remove(String applicationClass) {
classes.remove(applicationClass);
}
@@ -144,6 +156,7 @@ public void remove(String applicationClass) {
*
* @param name
* The fully qualified class name
+ * @return true if the class is loaded
*/
public boolean hasClass(String name) {
return classes.containsKey(name);
diff --git a/framework/src/play/classloading/ApplicationClassloader.java b/framework/src/play/classloading/ApplicationClassloader.java
index 6e2657a965..f9f686ba66 100644
--- a/framework/src/play/classloading/ApplicationClassloader.java
+++ b/framework/src/play/classloading/ApplicationClassloader.java
@@ -1,17 +1,8 @@
package play.classloading;
-import org.apache.commons.io.IOUtils;
-import org.apache.commons.lang.StringUtils;
-
-import play.Logger;
-import play.Play;
-import play.cache.Cache;
-import play.classloading.ApplicationClasses.ApplicationClass;
-import play.classloading.hash.ClassStateHashCreator;
-import play.exceptions.RestartNeededException;
-import play.exceptions.UnexpectedException;
-import play.libs.IO;
-import play.vfs.VirtualFile;
+import static java.util.Collections.unmodifiableList;
+import static java.util.Collections.unmodifiableMap;
+import static org.apache.commons.io.IOUtils.closeQuietly;
import java.io.File;
import java.io.IOException;
@@ -25,24 +16,40 @@
import java.security.Permissions;
import java.security.ProtectionDomain;
import java.security.cert.Certificate;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.Enumeration;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
-import static java.util.Collections.unmodifiableList;
-import static java.util.Collections.unmodifiableMap;
-import static org.apache.commons.io.IOUtils.closeQuietly;
+import org.apache.commons.io.IOUtils;
+import org.apache.commons.lang.StringUtils;
+
+import play.Logger;
+import play.Play;
+import play.cache.Cache;
+import play.classloading.ApplicationClasses.ApplicationClass;
+import play.classloading.hash.ClassStateHashCreator;
+import play.exceptions.RestartNeededException;
+import play.exceptions.UnexpectedException;
+import play.libs.IO;
+import play.vfs.VirtualFile;
/**
- * The application classLoader.
- * Load the classes from the application Java sources files.
+ * The application classLoader. Load the classes from the application Java sources files.
*/
public class ApplicationClassloader extends ClassLoader {
-
private final ClassStateHashCreator classStateHashCreator = new ClassStateHashCreator();
/**
- * A representation of the current state of the ApplicationClassloader.
- * It gets a new value each time the state of the classloader changes.
+ * A representation of the current state of the ApplicationClassloader. It gets a new value each time the state of
+ * the classloader changes.
*/
public ApplicationClassloaderState currentState = new ApplicationClassloaderState();
@@ -51,7 +58,7 @@ public class ApplicationClassloader extends ClassLoader {
*/
public ProtectionDomain protectionDomain;
- private final Object lock = new Object();
+ private final Object lock = new Object();
public ApplicationClassloader() {
super(ApplicationClassloader.class.getClassLoader());
@@ -78,8 +85,8 @@ protected Class loadClass(String name, boolean resolve) throws ClassNotFoundE
return c;
}
- synchronized( lock ) {
- // First check if it's an application Class
+ synchronized (lock) {
+ // First check if it's an application Class
Class applicationClass = loadApplicationClass(name);
if (applicationClass != null) {
if (resolve) {
@@ -96,7 +103,7 @@ public Class loadApplicationClass(String name) {
if (ApplicationClass.isClass(name)) {
Class maybeAlreadyLoaded = findLoadedClass(name);
- if(maybeAlreadyLoaded != null) {
+ if (maybeAlreadyLoaded != null) {
return maybeAlreadyLoaded;
}
}
@@ -149,7 +156,8 @@ public Class loadApplicationClass(String name) {
}
if (bc != null) {
applicationClass.enhancedByteCode = bc;
- applicationClass.javaClass = defineClass(applicationClass.name, applicationClass.enhancedByteCode, 0, applicationClass.enhancedByteCode.length, protectionDomain);
+ applicationClass.javaClass = defineClass(applicationClass.name, applicationClass.enhancedByteCode, 0,
+ applicationClass.enhancedByteCode.length, protectionDomain);
resolveClass(applicationClass.javaClass);
if (!applicationClass.isClass()) {
applicationClass.javaPackage = applicationClass.javaClass.getPackage();
@@ -163,7 +171,8 @@ public Class loadApplicationClass(String name) {
}
if (applicationClass.javaByteCode != null || applicationClass.compile() != null) {
applicationClass.enhance();
- applicationClass.javaClass = defineClass(applicationClass.name, applicationClass.enhancedByteCode, 0, applicationClass.enhancedByteCode.length, protectionDomain);
+ applicationClass.javaClass = defineClass(applicationClass.name, applicationClass.enhancedByteCode, 0,
+ applicationClass.enhancedByteCode.length, protectionDomain);
BytecodeCache.cacheBytecode(applicationClass.enhancedByteCode, name, applicationClass.javaSource);
resolveClass(applicationClass.javaClass);
if (!applicationClass.isClass()) {
@@ -296,6 +305,9 @@ public URL nextElement() {
/**
* Detect Java changes
+ *
+ * @throws play.exceptions.RestartNeededException
+ * Thrown if the application need to be restarted
*/
public void detectChanges() throws RestartNeededException {
// Now check for file modification
@@ -316,7 +328,7 @@ public void detectChanges() throws RestartNeededException {
for (ApplicationClass applicationClass : modifiedWithDependencies) {
if (applicationClass.compile() == null) {
Play.classes.classes.remove(applicationClass.name);
- currentState = new ApplicationClassloaderState();//show others that we have changed..
+ currentState = new ApplicationClassloaderState();// show others that we have changed..
} else {
int sigChecksum = applicationClass.sigChecksum;
applicationClass.enhance();
@@ -325,10 +337,10 @@ public void detectChanges() throws RestartNeededException {
}
BytecodeCache.cacheBytecode(applicationClass.enhancedByteCode, applicationClass.name, applicationClass.javaSource);
newDefinitions.add(new ClassDefinition(applicationClass.javaClass, applicationClass.enhancedByteCode));
- currentState = new ApplicationClassloaderState();//show others that we have changed..
+ currentState = new ApplicationClassloaderState();// show others that we have changed..
}
}
-
+
if (!newDefinitions.isEmpty()) {
Cache.clear();
if (HotswapAgent.enabled) {
@@ -353,11 +365,11 @@ public void detectChanges() throws RestartNeededException {
for (ApplicationClass applicationClass : Play.classes.all()) {
if (!applicationClass.javaFile.exists()) {
Play.classes.classes.remove(applicationClass.name);
- currentState = new ApplicationClassloaderState();//show others that we have changed..
+ currentState = new ApplicationClassloaderState();// show others that we have changed..
}
if (applicationClass.name.contains("$")) {
Play.classes.classes.remove(applicationClass.name);
- currentState = new ApplicationClassloaderState();//show others that we have changed..
+ currentState = new ApplicationClassloaderState();// show others that we have changed..
// Ok we have to remove all classes from the same file ...
VirtualFile vf = applicationClass.javaFile;
for (ApplicationClass ac : Play.classes.all()) {
@@ -370,7 +382,7 @@ public void detectChanges() throws RestartNeededException {
throw new RestartNeededException("Path has changed");
}
}
-
+
/**
* Used to track change of the application sources path
*/
@@ -382,6 +394,7 @@ private int computePathHash() {
/**
* Try to load all .java files found.
+ *
* @return The list of well defined Class
*/
public List getAllClasses() {
@@ -450,13 +463,15 @@ public int compare(Class o1, Class o2) {
}
return allClasses;
}
-
+
private List allClasses;
private Map allClassesByNormalizedName;
/**
* Retrieve all application classes assignable to this class.
- * @param clazz The superclass, or the interface.
+ *
+ * @param clazz
+ * The superclass, or the interface.
* @return A list of class
*/
public List getAssignableClasses(Class clazz) {
@@ -483,7 +498,9 @@ public List getAssignableClasses(Class clazz) {
/**
* Find a class in a case insensitive way
- * @param name The class name.
+ *
+ * @param name
+ * The class name.
* @return a class
*/
public Class getClassIgnoreCase(String name) {
@@ -501,7 +518,9 @@ public Class getClassIgnoreCase(String name) {
/**
* Retrieve all application classes with a specific annotation.
- * @param clazz The annotation class.
+ *
+ * @param clazz
+ * The annotation class.
* @return A list of class
*/
public List getAnnotatedClasses(Class clazz) {
@@ -520,7 +539,7 @@ public List getAnnotatedClasses(Class[] clazz) {
}
return results;
}
-
+
private List getAllClasses(VirtualFile path) {
return getAllClasses(path, "");
}
diff --git a/framework/src/play/classloading/ApplicationCompiler.java b/framework/src/play/classloading/ApplicationCompiler.java
index 48acb3c7e8..5b0e608f30 100644
--- a/framework/src/play/classloading/ApplicationCompiler.java
+++ b/framework/src/play/classloading/ApplicationCompiler.java
@@ -36,9 +36,12 @@ public class ApplicationCompiler {
Map packagesCache = new HashMap<>();
ApplicationClasses applicationClasses;
Map settings;
-
+
/**
* Try to guess the magic configuration options
+ *
+ * @param applicationClasses
+ * The application classes container
*/
public ApplicationCompiler(ApplicationClasses applicationClasses) {
this.applicationClasses = applicationClasses;
@@ -67,7 +70,6 @@ public ApplicationCompiler(ApplicationClasses applicationClasses) {
this.settings.put(CompilerOptions.OPTION_Compliance, javaVersion);
this.settings.put(CompilerOptions.OPTION_MethodParametersAttribute, CompilerOptions.GENERATE);
}
-
/**
* Something to compile
@@ -120,17 +122,18 @@ public char[][] getPackageName() {
@Override
public boolean ignoreOptionalProblems() {
- // TODO Auto-generated method stub
return false;
}
}
/**
* Please compile this className
+ *
+ * @param classNames
+ * Arrays of the class name to compile
*/
@SuppressWarnings("deprecation")
public void compile(String[] classNames) {
-
ICompilationUnit[] compilationUnits = new CompilationUnit[classNames.length];
for (int i = 0; i < classNames.length; i++) {
compilationUnits[i] = new CompilationUnit(classNames[i]);
diff --git a/framework/src/play/classloading/enhancers/Enhancer.java b/framework/src/play/classloading/enhancers/Enhancer.java
index d650c69301..d2c3abd69b 100644
--- a/framework/src/play/classloading/enhancers/Enhancer.java
+++ b/framework/src/play/classloading/enhancers/Enhancer.java
@@ -1,15 +1,16 @@
package play.classloading.enhancers;
-import java.io.File;
import java.io.ByteArrayInputStream;
+import java.io.File;
+import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
-import java.io.FileInputStream;
import java.lang.annotation.Annotation;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.HashMap;
import java.util.Map;
+
import javassist.ClassPath;
import javassist.ClassPool;
import javassist.CtClass;
@@ -19,8 +20,8 @@
import javassist.NotFoundException;
import javassist.bytecode.AnnotationsAttribute;
import javassist.bytecode.annotation.MemberValue;
-import play.Play;
import play.Logger;
+import play.Play;
import play.classloading.ApplicationClasses.ApplicationClass;
/**
@@ -33,7 +34,7 @@ public abstract class Enhancer {
public Enhancer() {
this.classPool = newClassPool();
}
-
+
public static ClassPool newClassPool() {
ClassPool classPool = new ClassPool();
classPool.appendSystemPath();
@@ -44,6 +45,12 @@ public static ClassPool newClassPool() {
/**
* Construct a javassist CtClass from an application class.
+ *
+ * @param applicationClass
+ * The application class to construct
+ * @return The javassist CtClass construct from the application class
+ * @throws IOException
+ * if problem occurred during construction
*/
public CtClass makeClass(ApplicationClass applicationClass) throws IOException {
return classPool.makeClass(new ByteArrayInputStream(applicationClass.enhancedByteCode));
@@ -51,6 +58,11 @@ public CtClass makeClass(ApplicationClass applicationClass) throws IOException {
/**
* The magic happen here...
+ *
+ * @param applicationClass
+ * The application class to construct
+ * @throws Exception
+ * if problem occurred during construction
*/
public abstract void enhanceThisClass(ApplicationClass applicationClass) throws Exception;
@@ -62,17 +74,17 @@ public static class ApplicationClassesClasspath implements ClassPath {
@Override
public InputStream openClassfile(String className) throws NotFoundException {
- if(Play.usePrecompiled) {
+ if (Play.usePrecompiled) {
try {
File file = Play.getFile("precompiled/java/" + className.replace(".", "/") + ".class");
return new FileInputStream(file);
- } catch(Exception e) {
+ } catch (Exception e) {
Logger.error("Missing class %s", className);
}
}
ApplicationClass appClass = Play.classes.getApplicationClass(className);
- if ( appClass.enhancedByteCode == null) {
+ if (appClass.enhancedByteCode == null) {
throw new RuntimeException("Trying to visit uncompiled class while enhancing. Uncompiled class: " + className);
}
@@ -98,11 +110,15 @@ public void close() {
}
/**
- * Test if a class has the provided annotation
- * @param ctClass the javassist class representation
- * @param annotation fully qualified name of the annotation class eg."javax.persistence.Entity"
+ * Test if a class has the provided annotation
+ *
+ * @param ctClass
+ * the javassist class representation
+ * @param annotation
+ * fully qualified name of the annotation class eg."javax.persistence.Entity"
* @return true if class has the annotation
* @throws java.lang.ClassNotFoundException
+ * if class not found
*/
protected boolean hasAnnotation(CtClass ctClass, String annotation) throws ClassNotFoundException {
for (Object object : ctClass.getAvailableAnnotations()) {
@@ -115,12 +131,16 @@ protected boolean hasAnnotation(CtClass ctClass, String annotation) throws Class
}
/**
- * Test if a field has the provided annotation
- * @param ctField the javassist field representation
- * @param annotation fully qualified name of the annotation class eg."javax.persistence.Entity"
+ * Test if a field has the provided annotation
+ *
+ * @param ctField
+ * the javassist field representation
+ * @param annotation
+ * fully qualified name of the annotation class eg."javax.persistence.Entity"
* @return true if field has the annotation
* @throws java.lang.ClassNotFoundException
- */
+ * if class not found
+ */
protected boolean hasAnnotation(CtField ctField, String annotation) throws ClassNotFoundException {
for (Object object : ctField.getAvailableAnnotations()) {
Annotation ann = (Annotation) object;
@@ -130,13 +150,17 @@ protected boolean hasAnnotation(CtField ctField, String annotation) throws Class
}
return false;
}
-
+
/**
* Test if a method has the provided annotation
- * @param ctMethod the javassist method representation
- * @param annotation fully qualified name of the annotation class eg."javax.persistence.Entity"
+ *
+ * @param ctMethod
+ * the javassist method representation
+ * @param annotation
+ * fully qualified name of the annotation class eg."javax.persistence.Entity"
* @return true if field has the annotation
* @throws java.lang.ClassNotFoundException
+ * if class not found
*/
protected boolean hasAnnotation(CtMethod ctMethod, String annotation) throws ClassNotFoundException {
for (Object object : ctMethod.getAvailableAnnotations()) {
@@ -150,9 +174,18 @@ protected boolean hasAnnotation(CtMethod ctMethod, String annotation) throws Cla
/**
* Create a new annotation to be dynamically inserted in the byte code.
+ *
+ * @param attribute
+ * annotation attribute
+ * @param annotationType
+ * Annotation
+ * @param members
+ * Member of the annotation
*/
- protected static void createAnnotation(AnnotationsAttribute attribute, Class annotationType, Map members) {
- javassist.bytecode.annotation.Annotation annotation = new javassist.bytecode.annotation.Annotation(annotationType.getName(), attribute.getConstPool());
+ protected static void createAnnotation(AnnotationsAttribute attribute, Class annotationType,
+ Map members) {
+ javassist.bytecode.annotation.Annotation annotation = new javassist.bytecode.annotation.Annotation(annotationType.getName(),
+ attribute.getConstPool());
for (Map.Entry member : members.entrySet()) {
annotation.addMemberValue(member.getKey(), member.getValue());
}
@@ -161,16 +194,26 @@ protected static void createAnnotation(AnnotationsAttribute attribute, Class annotationType) {
createAnnotation(attribute, annotationType, new HashMap());
}
/**
* Retrieve all class annotations.
+ *
+ * @param ctClass
+ * The given class
+ * @return All class annotations
*/
protected static AnnotationsAttribute getAnnotations(CtClass ctClass) {
- AnnotationsAttribute annotationsAttribute = (AnnotationsAttribute) ctClass.getClassFile().getAttribute(AnnotationsAttribute.visibleTag);
+ AnnotationsAttribute annotationsAttribute = (AnnotationsAttribute) ctClass.getClassFile()
+ .getAttribute(AnnotationsAttribute.visibleTag);
if (annotationsAttribute == null) {
annotationsAttribute = new AnnotationsAttribute(ctClass.getClassFile().getConstPool(), AnnotationsAttribute.visibleTag);
ctClass.getClassFile().addAttribute(annotationsAttribute);
@@ -180,9 +223,14 @@ protected static AnnotationsAttribute getAnnotations(CtClass ctClass) {
/**
* Retrieve all field annotations.
- */
+ *
+ * @param ctField
+ * The given field
+ * @return All field annotations.
+ */
protected static AnnotationsAttribute getAnnotations(CtField ctField) {
- AnnotationsAttribute annotationsAttribute = (AnnotationsAttribute) ctField.getFieldInfo().getAttribute(AnnotationsAttribute.visibleTag);
+ AnnotationsAttribute annotationsAttribute = (AnnotationsAttribute) ctField.getFieldInfo()
+ .getAttribute(AnnotationsAttribute.visibleTag);
if (annotationsAttribute == null) {
annotationsAttribute = new AnnotationsAttribute(ctField.getFieldInfo().getConstPool(), AnnotationsAttribute.visibleTag);
ctField.getFieldInfo().addAttribute(annotationsAttribute);
@@ -192,9 +240,14 @@ protected static AnnotationsAttribute getAnnotations(CtField ctField) {
/**
* Retrieve all method annotations.
- */
+ *
+ * @param ctMethod
+ * The given methods
+ * @return all method annotations.
+ */
protected static AnnotationsAttribute getAnnotations(CtMethod ctMethod) {
- AnnotationsAttribute annotationsAttribute = (AnnotationsAttribute) ctMethod.getMethodInfo().getAttribute(AnnotationsAttribute.visibleTag);
+ AnnotationsAttribute annotationsAttribute = (AnnotationsAttribute) ctMethod.getMethodInfo()
+ .getAttribute(AnnotationsAttribute.visibleTag);
if (annotationsAttribute == null) {
annotationsAttribute = new AnnotationsAttribute(ctMethod.getMethodInfo().getConstPool(), AnnotationsAttribute.visibleTag);
ctMethod.getMethodInfo().addAttribute(annotationsAttribute);
@@ -203,8 +256,8 @@ protected static AnnotationsAttribute getAnnotations(CtMethod ctMethod) {
}
boolean isScalaObject(CtClass ctClass) throws Exception {
- for(CtClass i : ctClass.getInterfaces()) {
- if(i.getName().equals("scala.ScalaObject")) {
+ for (CtClass i : ctClass.getInterfaces()) {
+ if (i.getName().equals("scala.ScalaObject")) {
return true;
}
}
@@ -218,5 +271,4 @@ boolean isScala(ApplicationClass app) {
boolean isAnon(ApplicationClass app) {
return app.name.contains("$anonfun$") || app.name.contains("$anon$");
}
-
-}
+}
\ No newline at end of file
diff --git a/framework/src/play/classloading/enhancers/LocalvariablesNamesEnhancer.java b/framework/src/play/classloading/enhancers/LocalvariablesNamesEnhancer.java
index b277ed44de..48d1b88df7 100644
--- a/framework/src/play/classloading/enhancers/LocalvariablesNamesEnhancer.java
+++ b/framework/src/play/classloading/enhancers/LocalvariablesNamesEnhancer.java
@@ -1,14 +1,22 @@
package play.classloading.enhancers;
+import java.lang.reflect.Field;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Stack;
+
import javassist.CtClass;
import javassist.CtMethod;
-import javassist.bytecode.*;
+import javassist.bytecode.Bytecode;
+import javassist.bytecode.CodeAttribute;
+import javassist.bytecode.CodeIterator;
+import javassist.bytecode.LocalVariableAttribute;
+import javassist.bytecode.Opcode;
import play.Logger;
import play.classloading.ApplicationClasses.ApplicationClass;
-import java.lang.reflect.Field;
-import java.util.*;
-
/**
* Track names of local variables ...
*/
@@ -21,7 +29,8 @@ public void enhanceThisClass(ApplicationClass applicationClass) throws Exception
}
CtClass ctClass = makeClass(applicationClass);
- if (!ctClass.subtypeOf(classPool.get(LocalVariablesSupport.class.getName())) && !ctClass.getName().matches("^controllers\\..*\\$class$")) {
+ if (!ctClass.subtypeOf(classPool.get(LocalVariablesSupport.class.getName()))
+ && !ctClass.getName().matches("^controllers\\..*\\$class$")) {
return;
}
@@ -71,7 +80,7 @@ public void enhanceThisClass(ApplicationClass applicationClass) throws Exception
CodeIterator codeIterator = codeAttribute.iterator();
codeIterator.move(pc);
pc = codeIterator.next();
-
+
Bytecode b = makeBytecodeForLVStore(method, localVariableAttribute.signature(i), name, localVariableAttribute.index(i));
codeIterator.insert(pc, b.get());
codeAttribute.setMaxStack(codeAttribute.computeMaxStack());
@@ -95,9 +104,12 @@ public void enhanceThisClass(ApplicationClass applicationClass) throws Exception
// Si c'est un store de la variable en cours d'examination
// et que c'est dans la frame d'utilisation de cette variable on trace l'affectation.
- // (en fait la frame commence à localVariableAttribute.startPc(i)-1 qui est la première affectation
- // mais aussi l'initialisation de la variable qui est deja tracé plus haut, donc on commence à localVariableAttribute.startPc(i))
- if (varNumber == localVariableAttribute.index(i) && index < localVariableAttribute.startPc(i) + localVariableAttribute.codeLength(i)) {
+ // (en fait la frame commence à localVariableAttribute.startPc(i)-1 qui est la première
+ // affectation
+ // mais aussi l'initialisation de la variable qui est deja tracé plus haut, donc on commence à
+ // localVariableAttribute.startPc(i))
+ if (varNumber == localVariableAttribute.index(i)
+ && index < localVariableAttribute.startPc(i) + localVariableAttribute.codeLength(i)) {
b = makeBytecodeForLVStore(method, localVariableAttribute.signature(i), aliasedName, varNumber);
codeIterator.insertEx(b.get());
codeAttribute.setMaxStack(codeAttribute.computeMaxStack());
@@ -120,30 +132,31 @@ public void enhanceThisClass(ApplicationClass applicationClass) throws Exception
ctClass.defrost();
}
-
+
static Bytecode makeBytecodeForLVStore(CtMethod method, String sig, String name, int slot) {
Bytecode b = new Bytecode(method.getMethodInfo().getConstPool());
b.addLdc(name);
- if("I".equals(sig) || "B".equals(sig) || "C".equals(sig) || "S".equals(sig) || "Z".equals(sig))
+ if ("I".equals(sig) || "B".equals(sig) || "C".equals(sig) || "S".equals(sig) || "Z".equals(sig))
b.addIload(slot);
- else if("F".equals(sig))
+ else if ("F".equals(sig))
b.addFload(slot);
- else if("J".equals(sig))
+ else if ("J".equals(sig))
b.addLload(slot);
- else if("D".equals(sig))
+ else if ("D".equals(sig))
b.addDload(slot);
else
b.addAload(slot);
-
+
String localVarDescriptor = sig;
- if(!"B".equals(sig) && !"C".equals(sig) && !"D".equals(sig) && !"F".equals(sig) &&
- !"I".equals(sig) && !"J".equals(sig) && !"S".equals(sig) && !"Z".equals(sig))
+ if (!"B".equals(sig) && !"C".equals(sig) && !"D".equals(sig) && !"F".equals(sig) && !"I".equals(sig) && !"J".equals(sig)
+ && !"S".equals(sig) && !"Z".equals(sig))
localVarDescriptor = "Ljava/lang/Object;";
Logger.trace("for variable '%s' in slot=%s, sig was '%s' and is now '%s'", name, slot, sig, localVarDescriptor);
- b.addInvokestatic("play.classloading.enhancers.LocalvariablesNamesEnhancer$LocalVariablesNamesTracer", "addVariable", "(Ljava/lang/String;"+localVarDescriptor+")V");
-
+ b.addInvokestatic("play.classloading.enhancers.LocalvariablesNamesEnhancer$LocalVariablesNamesTracer", "addVariable",
+ "(Ljava/lang/String;" + localVarDescriptor + ")V");
+
return b;
}
@@ -252,19 +265,20 @@ public static Object getLocalVariable(String variable) {
public static Stack> getLocalVariablesStateBeforeAwait() {
Stack> state = localVariables.get();
- // must clear the ThreadLocal to prevent destroying the state when exit() is called due to continuations-suspend
+ // must clear the ThreadLocal to prevent destroying the state when exit() is called due to
+ // continuations-suspend
localVariables.set(new Stack>());
return state;
}
public static void setLocalVariablesStateAfterAwait(Stack> state) {
- if (state==null) {
+ if (state == null) {
state = new Stack<>();
}
- localVariables.set( state );
+ localVariables.set(state);
}
}
-
+
static final Map storeByCode = new HashMap<>();
/*
@@ -305,11 +319,15 @@ public static void setLocalVariablesStateAfterAwait(Stack> s
/**
* Debug utility. Display a byte code op as plain text.
+ *
+ * @param op
+ * The given byte code
*/
public static void printOp(int op) {
try {
for (Field f : Opcode.class.getDeclaredFields()) {
- if (java.lang.reflect.Modifier.isStatic(f.getModifiers()) && java.lang.reflect.Modifier.isPublic(f.getModifiers()) && f.getInt(null) == op) {
+ if (java.lang.reflect.Modifier.isStatic(f.getModifiers()) && java.lang.reflect.Modifier.isPublic(f.getModifiers())
+ && f.getInt(null) == op) {
System.out.println(op + " " + f.getName());
}
}
diff --git a/framework/src/play/data/binding/AnnotationHelper.java b/framework/src/play/data/binding/AnnotationHelper.java
index 3f186867e0..8b5153ce3f 100644
--- a/framework/src/play/data/binding/AnnotationHelper.java
+++ b/framework/src/play/data/binding/AnnotationHelper.java
@@ -19,10 +19,12 @@ public class AnnotationHelper {
* It can be something like As(lang={"fr,de","*"}, value={"dd-MM-yyyy","MM-dd-yyyy"})
*
* @param annotations
+ * Annotations associated with on the date
* @param value
+ * The formated date
* @return null if it cannot be converted because there is no annotation.
* @throws ParseException
- *
+ * if problem occurred during parsing the date
*/
public static Date getDateAs(Annotation[] annotations, String value) throws ParseException {
// Look up for the BindAs annotation
@@ -35,7 +37,7 @@ public static Date getDateAs(Annotation[] annotations, String value) throws Pars
Locale locale = Lang.getLocale();
String format = as.value()[0];
// According to Binder.java line 328 : Fixtures can use (iso) dates as default
- if(format != null && format.equals(Fixtures.PROFILE_NAME)){
+ if (format != null && format.equals(Fixtures.PROFILE_NAME)) {
format = DateBinder.ISO8601;
locale = null;
} else if (!StringUtils.isEmpty(format)) {
@@ -50,7 +52,7 @@ public static Date getDateAs(Annotation[] annotations, String value) throws Pars
if (StringUtils.isEmpty(format)) {
format = I18N.getDateFormat();
}
- SimpleDateFormat sdf = locale != null ? new SimpleDateFormat(format, locale) : new SimpleDateFormat(format);
+ SimpleDateFormat sdf = locale != null ? new SimpleDateFormat(format, locale) : new SimpleDateFormat(format);
sdf.setLenient(false);
return sdf.parse(value);
}
@@ -85,7 +87,7 @@ public static Tuple getLocale(String[] langs) {
* Contains the index of the locale inside the @As
*/
private static class Tuple {
-
+
public int index = -1;
public Locale locale;
diff --git a/framework/src/play/data/binding/Binder.java b/framework/src/play/data/binding/Binder.java
index 1d6258ca45..124c90f160 100644
--- a/framework/src/play/data/binding/Binder.java
+++ b/framework/src/play/data/binding/Binder.java
@@ -1,23 +1,52 @@
package play.data.binding;
+import java.io.File;
+import java.lang.annotation.Annotation;
+import java.lang.reflect.Array;
+import java.lang.reflect.Constructor;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import java.lang.reflect.ParameterizedType;
+import java.lang.reflect.Type;
+import java.math.BigDecimal;
+import java.text.ParseException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Calendar;
+import java.util.Collection;
+import java.util.Comparator;
+import java.util.Date;
+import java.util.EnumSet;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Set;
+import java.util.SortedSet;
+import java.util.TreeSet;
+
import org.apache.commons.lang.StringUtils;
import org.joda.time.DateTime;
+
import play.Logger;
import play.Play;
import play.data.Upload;
-import play.data.binding.types.*;
+import play.data.binding.types.BinaryBinder;
+import play.data.binding.types.ByteArrayArrayBinder;
+import play.data.binding.types.ByteArrayBinder;
+import play.data.binding.types.CalendarBinder;
+import play.data.binding.types.DateBinder;
+import play.data.binding.types.DateTimeBinder;
+import play.data.binding.types.FileArrayBinder;
+import play.data.binding.types.FileBinder;
+import play.data.binding.types.LocaleBinder;
+import play.data.binding.types.UploadArrayBinder;
+import play.data.binding.types.UploadBinder;
import play.data.validation.Validation;
import play.db.Model;
import play.exceptions.UnexpectedException;
-import java.io.File;
-import java.lang.annotation.Annotation;
-import java.lang.reflect.*;
-import java.math.BigDecimal;
-import java.text.ParseException;
-import java.util.*;
-
-
/**
* The binder try to convert String values to Java objects.
*/
@@ -48,9 +77,15 @@ public abstract class Binder {
*
* E.g. @{code Binder.register(BigDecimal.class, new MyBigDecimalBinder());}
*
- * NB! Do not forget to UNREGISTER your custom binder when applications is reloaded (most probably in method onApplicationStop()).
- * Otherwise you will have a memory leak.
+ * NB! Do not forget to UNREGISTER your custom binder when applications is reloaded (most probably in method
+ * onApplicationStop()). Otherwise you will have a memory leak.
*
+ * @param clazz
+ * The class to register
+ * @param typeBinder
+ * The custom binder
+ * @param
+ * The Class type to register
* @see #unregister(java.lang.Class)
*/
public static void register(Class clazz, TypeBinder typeBinder) {
@@ -59,6 +94,11 @@ public static void register(Class clazz, TypeBinder typeBinder) {
/**
* Remove custom binder that was add with method #register(java.lang.Class, play.data.binding.TypeBinder)
+ *
+ * @param clazz
+ * The class to remove the custom binder
+ * @param
+ * The Class type to register
*/
public static void unregister(Class clazz) {
supportedTypes.remove(clazz);
@@ -88,6 +128,14 @@ public MethodAndParamInfo(Object objectInstance, Method method, int parameterInd
/**
* Deprecated. Use bindBean() instead.
+ *
+ * @param o
+ * Object to bind
+ * @param name
+ * Name of the object
+ * @param params
+ * List of the parameters
+ * @return : The binding object
*/
@Deprecated
public static Object bind(Object o, String name, Map params) {
@@ -106,7 +154,8 @@ public static Object bind(RootParamNode parentParamNode, String name, Class c
return bind(parentParamNode, name, clazz, type, annotations, null);
}
- public static Object bind(RootParamNode parentParamNode, String name, Class clazz, Type type, Annotation[] annotations, MethodAndParamInfo methodAndParamInfo) {
+ public static Object bind(RootParamNode parentParamNode, String name, Class clazz, Type type, Annotation[] annotations,
+ MethodAndParamInfo methodAndParamInfo) {
ParamNode paramNode = parentParamNode.getChild(name, true);
Object result = null;
@@ -136,7 +185,8 @@ public static Object bind(RootParamNode parentParamNode, String name, Class c
if (methodAndParamInfo != null) {
try {
Method method = methodAndParamInfo.method;
- Method defaultMethod = method.getDeclaringClass().getDeclaredMethod(method.getName() + "$default$" + methodAndParamInfo.parameterIndex);
+ Method defaultMethod = method.getDeclaringClass()
+ .getDeclaredMethod(method.getName() + "$default$" + methodAndParamInfo.parameterIndex);
return defaultMethod.invoke(methodAndParamInfo.objectInstance);
} catch (NoSuchMethodException ignore) {
} catch (Exception e) {
@@ -173,7 +223,6 @@ public static Object bind(RootParamNode parentParamNode, String name, Class c
}
-
protected static Object internalBind(ParamNode paramNode, Class clazz, Type type, BindingAnnotations bindingAnnotations) {
if (paramNode == null) {
@@ -202,14 +251,16 @@ protected static Object internalBind(ParamNode paramNode, Class clazz, Type t
return bindCollection(clazz, type, paramNode, bindingAnnotations);
}
- Object directBindResult = internalDirectBind(paramNode.getOriginalKey(), bindingAnnotations.annotations, paramNode.getFirstValue(clazz), clazz, type);
-
+ Object directBindResult = internalDirectBind(paramNode.getOriginalKey(), bindingAnnotations.annotations,
+ paramNode.getFirstValue(clazz), clazz, type);
+
if (directBindResult != DIRECTBINDING_NO_RESULT) {
// we found a value/result when direct binding
return directBindResult;
}
- // Must do the default array-check after direct binding, since some custom-binders checks for specific arrays
+ // Must do the default array-check after direct binding, since some custom-binders checks for specific
+ // arrays
if (clazz.isArray()) {
return bindArray(clazz, paramNode, bindingAnnotations);
}
@@ -267,7 +318,8 @@ private static Object bindArray(Class clazz, ParamNode paramNode, BindingAnno
for (int i = 0; i < size; i++) {
String thisValue = values[i];
try {
- Array.set(array, i - invalidItemsCount, directBind(paramNode.getOriginalKey(), bindingAnnotations.annotations, thisValue, componentType, componentType));
+ Array.set(array, i - invalidItemsCount, directBind(paramNode.getOriginalKey(), bindingAnnotations.annotations,
+ thisValue, componentType, componentType));
} catch (Exception e) {
Logger.debug("Bad item #%s: %s", i, e);
invalidItemsCount++;
@@ -326,6 +378,13 @@ private static T createNewInstance(Class clazz) {
/**
* Invokes the plugins before using the internal bindBean.
+ *
+ * @param rootParamNode
+ * List of parameters
+ * @param name
+ * The object name
+ * @param bean
+ * the bean object
*/
public static void bindBean(RootParamNode rootParamNode, String name, Object bean) {
@@ -348,6 +407,13 @@ public static void bindBean(RootParamNode rootParamNode, String name, Object bea
/**
* Does NOT invoke plugins
+ *
+ * @param paramNode
+ * List of parameters
+ * @param bean
+ * the bean object
+ * @param annotations
+ * annotations associated with the object
*/
public static void bindBean(ParamNode paramNode, Object bean, Annotation[] annotations) {
internalBindBean(paramNode, bean, new BindingAnnotations(annotations));
@@ -407,7 +473,8 @@ private static Object bindMap(Type type, ParamNode paramNode, BindingAnnotations
for (ParamNode child : paramNode.getAllChildren()) {
try {
- Object keyObject = directBind(paramNode.getOriginalKey(), bindingAnnotations.annotations, child.getName(), keyClass, keyClass);
+ Object keyObject = directBind(paramNode.getOriginalKey(), bindingAnnotations.annotations, child.getName(), keyClass,
+ keyClass);
Object valueObject = internalBind(child, valueClass, valueClass, bindingAnnotations);
if (valueObject == NO_BINDING || valueObject == MISSING) {
valueObject = null;
@@ -443,7 +510,7 @@ private static Object bindCollection(Class clazz, Type type, ParamNode paramN
Type componentType = String.class;
if (type instanceof ParameterizedType) {
componentType = ((ParameterizedType) type).getActualTypeArguments()[0];
- if(componentType instanceof ParameterizedType) {
+ if (componentType instanceof ParameterizedType) {
componentClass = (Class) ((ParameterizedType) componentType).getRawType();
} else {
componentClass = (Class) componentType;
@@ -479,10 +546,11 @@ private static Object bindCollection(Class clazz, Type type, ParamNode paramN
boolean hasMissing = false;
for (int i = 0; i < values.length; i++) {
try {
- Object value = internalDirectBind(paramNode.getOriginalKey(), bindingAnnotations.annotations, values[i], componentClass, componentType);
- if ( value == DIRECTBINDING_NO_RESULT) {
- hasMissing = true;
- } else {
+ Object value = internalDirectBind(paramNode.getOriginalKey(), bindingAnnotations.annotations, values[i], componentClass,
+ componentType);
+ if (value == DIRECTBINDING_NO_RESULT) {
+ hasMissing = true;
+ } else {
l.add(value);
}
} catch (Exception e) {
@@ -490,10 +558,10 @@ private static Object bindCollection(Class clazz, Type type, ParamNode paramN
logBindingNormalFailure(paramNode, e); // TODO debug or error?
}
}
- if(hasMissing && l.size() == 0){
+ if (hasMissing && l.size() == 0) {
return MISSING;
}
- return l;
+ return l;
}
Collection r = (Collection) createNewInstance(clazz);
@@ -550,21 +618,54 @@ public int compare(String arg0, String arg1) {
}
/**
+ * Bind a object
+ *
+ * @param value
+ * value to bind
+ * @param clazz
+ * class of the object
* @return The binding object
+ * @throws Exception
+ * if problem occurred during binding
*/
public static Object directBind(String value, Class clazz) throws Exception {
return directBind(null, value, clazz, null);
}
/**
+ * Bind a object
+ *
+ * @param name
+ * name of the object
+ * @param annotations
+ * annotation on the object
+ * @param value
+ * Value to bind
+ * @param clazz
+ * The class of the object
+ *
* @return The binding object
+ * @throws Exception
+ * if problem occurred during binding
*/
public static Object directBind(String name, Annotation[] annotations, String value, Class clazz) throws Exception {
return directBind(name, annotations, value, clazz, null);
}
/**
+ * Bind a object
+ *
+ * @param annotations
+ * annotation on the object
+ * @param value
+ * value to bind
+ * @param clazz
+ * class of the object
+ * @param type
+ * type to bind
* @return The binding object
+ * @throws Exception
+ * if problem occurred during binding
*/
public static Object directBind(Annotation[] annotations, String value, Class clazz, Type type) throws Exception {
return directBind(null, annotations, value, clazz, type);
@@ -572,13 +673,25 @@ public static Object directBind(Annotation[] annotations, String value, Class
/**
* This method calls the user's defined binders prior to bind simple type
- *
+ *
+ * @param name
+ * name of the object
+ * @param annotations
+ * annotation on the object
+ * @param value
+ * value to bind
+ * @param clazz
+ * class of the object
+ * @param type
+ * type to bind
* @return The binding object
+ * @throws Exception
+ * if problem occurred during binding
*/
public static Object directBind(String name, Annotation[] annotations, String value, Class clazz, Type type) throws Exception {
// calls the direct binding and returns null if no value could be resolved..
Object r = internalDirectBind(name, annotations, value, clazz, type);
- if ( r == DIRECTBINDING_NO_RESULT) {
+ if (r == DIRECTBINDING_NO_RESULT) {
return null;
} else {
return r;
@@ -587,7 +700,8 @@ public static Object directBind(String name, Annotation[] annotations, String va
// If internalDirectBind was not able to bind it, it returns a special variable instance: DIRECTBIND_MISSING
// Needs this because sometimes we need to know if no value was returned..
- private static Object internalDirectBind(String name, Annotation[] annotations, String value, Class clazz, Type type) throws Exception {
+ private static Object internalDirectBind(String name, Annotation[] annotations, String value, Class clazz, Type type)
+ throws Exception {
boolean nullOrEmpty = value == null || value.trim().length() == 0;
if (annotations != null) {
diff --git a/framework/src/play/data/binding/TypeUnbinder.java b/framework/src/play/data/binding/TypeUnbinder.java
index 71986dd1bf..0ac06e6f37 100644
--- a/framework/src/play/data/binding/TypeUnbinder.java
+++ b/framework/src/play/data/binding/TypeUnbinder.java
@@ -5,19 +5,28 @@
/**
* Supported type for unbinding. This interface is used to implement custom unbinders.
+ *
+ * @param
+ * Type of the unbinder
*
*/
public interface TypeUnbinder {
-
- /**
+
+ /**
* @param result
- * @param src the object you want to unbind
- * @param srcClazz The class of the object you want to associate the value with
- * @param name the name of you parameter ie myparam for a simple param but can also be a complex one : mybean.address.street
- * @param annotations An array of annotation that may be bound to your method parameter or your bean property
- * @return true si unbinder is successful, otherwise false and will use the default unbinder
+ * The result container
+ * @param src
+ * the object you want to unbind
+ * @param srcClazz
+ * The class of the object you want to associate the value with
+ * @param name
+ * the name of you parameter ie myparam for a simple param but can also be a complex one :
+ * mybean.address.street
+ * @param annotations
+ * An array of annotation that may be bound to your method parameter or your bean property
+ * @return true if unwinder is successful, otherwise false and will use the default unbinder
* @throws Exception
+ * if problem occurred
*/
boolean unBind(Map result, Object src, Class srcClazz, String name, Annotation[] annotations) throws Exception;
-
}
diff --git a/framework/src/play/data/parsing/ApacheMultipartParser.java b/framework/src/play/data/parsing/ApacheMultipartParser.java
index 61c22ddcef..6603bf254d 100644
--- a/framework/src/play/data/parsing/ApacheMultipartParser.java
+++ b/framework/src/play/data/parsing/ApacheMultipartParser.java
@@ -1,6 +1,28 @@
package play.data.parsing;
-import org.apache.commons.fileupload.*;
+import static org.apache.commons.io.FileUtils.readFileToByteArray;
+
+import java.io.ByteArrayInputStream;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.io.UnsupportedEncodingException;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.NoSuchElementException;
+
+import org.apache.commons.fileupload.FileItem;
+import org.apache.commons.fileupload.FileItemHeaders;
+import org.apache.commons.fileupload.FileItemIterator;
+import org.apache.commons.fileupload.FileItemStream;
+import org.apache.commons.fileupload.FileUploadBase;
+import org.apache.commons.fileupload.FileUploadException;
+import org.apache.commons.fileupload.ParameterParser;
+import org.apache.commons.fileupload.RequestContext;
import org.apache.commons.fileupload.disk.DiskFileItem;
import org.apache.commons.fileupload.util.Closeable;
import org.apache.commons.fileupload.util.LimitedInputStream;
@@ -9,6 +31,7 @@
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.FilenameUtils;
import org.apache.commons.io.output.DeferredFileOutputStream;
+
import play.Logger;
import play.Play;
import play.data.FileUpload;
@@ -18,14 +41,8 @@
import play.mvc.Http.Request;
import play.utils.HTTP;
-import java.io.*;
-import java.util.*;
-
-import static org.apache.commons.io.FileUtils.readFileToByteArray;
-
/**
- * From Apache commons fileupload.
- * http://commons.apache.org/fileupload/
+ * From Apache commons fileupload. http://commons.apache.org/fileupload/
*/
public class ApacheMultipartParser extends DataParser {
@@ -46,35 +63,33 @@ private static void putMapEntry(Map map, String name, String v
/*
* Copyright 2001-2004 The Apache Software Foundation
*
- * 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
+ * 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
+ * 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.
+ * 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.
*
- * The default implementation of the
- * {@link org.apache.commons.fileupload.FileItem FileItem} interface.
+ *
The default implementation of the {@link org.apache.commons.fileupload.FileItem FileItem} interface.
*
- *
After retrieving an instance of this class from a {@link
- * org.apache.commons.fileupload.DiskFileUpload DiskFileUpload} instance (see
- * {@link org.apache.commons.fileupload.DiskFileUpload
- * #parseRequest(javax.servlet.http.HttpServletRequest)}), you may
- * either request all contents of file at once using {@link #get()} or
- * request an {@link java.io.InputStream InputStream} with
- * {@link #getInputStream()} and process the file without attempting to load
- * it into memory, which may come handy with large files.
+ *
After retrieving an instance of this class from a {@link org.apache.commons.fileupload.DiskFileUpload
+ * DiskFileUpload} instance (see {@link org.apache.commons.fileupload.DiskFileUpload
+ * #parseRequest(javax.servlet.http.HttpServletRequest)}), you may either request all contents of file at once using
+ * {@link #get()} or request an {@link java.io.InputStream InputStream} with {@link #getInputStream()} and process
+ * the file without attempting to load it into memory, which may come handy with large files.
*
* @author Rafal Krzewski
+ *
* @author Sean Legassick
+ *
* @author Jason van Zyl
+ *
* @author John McNally
+ *
* @author Martin Cooper
+ *
* @author Sean C. Sullivan
*
* @since FileUpload 1.1
@@ -91,10 +106,9 @@ public static class AutoFileItem implements FileItem {
// ----------------------------------------------------- Manifest constants
/**
- * Default content charset to be used when no explicit charset
- * parameter is provided by the sender. Media subtypes of the
- * "text" type are defined to have a default charset value of
- * "ISO-8859-1" when received via HTTP.
+ * Default content charset to be used when no explicit charset parameter is provided by the sender. Media
+ * subtypes of the "text" type are defined to have a default charset value of "ISO-8859-1" when received via
+ * HTTP.
*/
public static final String DEFAULT_CHARSET = "ISO-8859-1";
/**
@@ -112,8 +126,7 @@ public static class AutoFileItem implements FileItem {
*/
private String fieldName;
/**
- * The content type passed by the browser, or null if
- * not defined.
+ * The content type passed by the browser, or null if not defined.
*/
private String contentType;
/**
@@ -140,9 +153,9 @@ public static class AutoFileItem implements FileItem {
* Output stream for this item.
*/
private DeferredFileOutputStream dfos;
-
+
/**
- * The file items headers.
+ * The file items headers.
*/
private FileItemHeaders headers;
@@ -157,16 +170,14 @@ public AutoFileItem(FileItemStream stream) {
// ------------------------------- Methods from javax.activation.DataSource
/**
- * Returns an {@link java.io.InputStream InputStream} that can be
- * used to retrieve the contents of the file.
+ * Returns an {@link java.io.InputStream InputStream} that can be used to retrieve the contents of the file.
*
- * @return An {@link java.io.InputStream InputStream} that can be
- * used to retrieve the contents of the file.
- * @throws IOException if an error occurs.
+ * @return An {@link java.io.InputStream InputStream} that can be used to retrieve the contents of the file.
+ * @throws IOException
+ * if an error occurs.
*/
@Override
- public InputStream getInputStream()
- throws IOException {
+ public InputStream getInputStream() throws IOException {
if (!dfos.isInMemory()) {
return new FileInputStream(dfos.getFile());
}
@@ -178,11 +189,9 @@ public InputStream getInputStream()
}
/**
- * Returns the content type passed by the agent or null if
- * not defined.
+ * Returns the content type passed by the agent or null if not defined.
*
- * @return The content type passed by the agent or null if
- * not defined.
+ * @return The content type passed by the agent or null if not defined.
*/
@Override
public String getContentType() {
@@ -190,18 +199,16 @@ public String getContentType() {
}
/**
- * Returns the content charset passed by the agent or null if
- * not defined.
+ * Returns the content charset passed by the agent or null if not defined.
*
- * @return The content charset passed by the agent or null if
- * not defined.
+ * @return The content charset passed by the agent or null if not defined.
*/
public String getCharSet() {
ParameterParser parser = new ParameterParser();
parser.setLowerCaseNames(true);
// Parameter parser can handle null input
Map params = parser.parse(getContentType(), ';');
- return (String) params.get("charset");
+ return params.get("charset");
}
/**
@@ -216,11 +223,9 @@ public String getName() {
// ------------------------------------------------------- FileItem methods
/**
- * Provides a hint as to whether or not the file contents will be read
- * from memory.
+ * Provides a hint as to whether or not the file contents will be read from memory.
*
- * @return true if the file contents will be read
- * from memory; false otherwise.
+ * @return true if the file contents will be read from memory; false otherwise.
*/
@Override
public boolean isInMemory() {
@@ -244,9 +249,8 @@ public long getSize() {
}
/**
- * Returns the contents of the file as an array of bytes. If the
- * contents of the file were not yet cached in memory, they will be
- * loaded from the disk storage and cached.
+ * Returns the contents of the file as an array of bytes. If the contents of the file were not yet cached in
+ * memory, they will be loaded from the disk storage and cached.
*
* @return The contents of the file as an array of bytes.
*/
@@ -267,28 +271,29 @@ public byte[] get() {
}
/**
- * Returns the contents of the file as a String, using the specified
- * encoding. This method uses {@link #get()} to retrieve the
- * contents of the file.
+ * Returns the contents of the file as a String, using the specified encoding. This method uses {@link #get()}
+ * to retrieve the contents of the file.
*
- * @param charset The charset to use.
+ * @param charset
+ * The charset to use.
* @return The contents of the file, as a string.
- * @throws UnsupportedEncodingException if the requested character
- * encoding is not available.
+ * @throws UnsupportedEncodingException
+ * if the requested character encoding is not available.
*/
@Override
- public String getString(String charset)
- throws UnsupportedEncodingException {
+ public String getString(String charset) throws UnsupportedEncodingException {
return new String(get(), charset);
}
/**
- * Returns the contents of the file as a String, using the default
- * character encoding. This method uses {@link #get()} to retrieve the
- * contents of the file.
- *
+ * Returns the contents of the file as a String, using the default character encoding. This method uses
+ * {@link #get()} to retrieve the contents of the file.
+ *
+ *
+ * @play.todo Note: TODO Consider making this method throw UnsupportedEncodingException .
+ *
+ *
* @return The contents of the file, as a string.
- * @todo Consider making this method throw UnsupportedEncodingException.
*/
@Override
public String getString() {
@@ -305,23 +310,21 @@ public String getString() {
}
/**
- * A convenience method to write an uploaded item to disk. The client code
- * is not concerned with whether or not the item is stored in memory, or on
- * disk in a temporary location. They just want to write the uploaded item
+ * A convenience method to write an uploaded item to disk. The client code is not concerned with whether or not
+ * the item is stored in memory, or on disk in a temporary location. They just want to write the uploaded item
* to a file.
*
- * This implementation first attempts to rename the uploaded item to the
- * specified destination file, if the item was originally written to disk.
- * Otherwise, the data will be copied to the specified file.
+ * This implementation first attempts to rename the uploaded item to the specified destination file, if the item
+ * was originally written to disk. Otherwise, the data will be copied to the specified file.
*
- * This method is only guaranteed to work once, the first time it
- * is invoked for a particular item. This is because, in the event that the
- * method renames a temporary file, that file will no longer be available
+ * This method is only guaranteed to work once, the first time it is invoked for a particular item.
+ * This is because, in the event that the method renames a temporary file, that file will no longer be available
* to copy or rename again at a later time.
*
- * @param file The File into which the uploaded item should
- * be stored.
- * @throws Exception if an error occurs.
+ * @param file
+ * The File into which the uploaded item should be stored.
+ * @throws Exception
+ * if an error occurs.
*/
@Override
public void write(File file) throws Exception {
@@ -331,30 +334,25 @@ public void write(File file) throws Exception {
File outputFile = getStoreLocation();
if (outputFile != null) {
/*
- * The uploaded file is being stored on disk
- * in a temporary location so move it to the
- * desired file.
+ * The uploaded file is being stored on disk in a temporary location so move it to the desired file.
*/
if (!outputFile.renameTo(file)) {
FileUtils.copyFile(outputFile, file);
}
} else {
/*
- * For whatever reason we cannot write the
- * file to disk.
+ * For whatever reason we cannot write the file to disk.
*/
- throw new FileUploadException(
- "Cannot write uploaded file to disk!");
+ throw new FileUploadException("Cannot write uploaded file to disk!");
}
}
}
/**
- * Deletes the underlying storage for a file item, including deleting any
- * associated temporary disk file. Although this storage will be deleted
- * automatically when the FileItem instance is garbage
- * collected, this method can be used to ensure that this is done at an
- * earlier time, thus preserving system resources.
+ * Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
+ * Although this storage will be deleted automatically when the FileItem instance is garbage
+ * collected, this method can be used to ensure that this is done at an earlier time, thus preserving system
+ * resources.
*/
@Override
public void delete() {
@@ -366,8 +364,7 @@ public void delete() {
}
/**
- * Returns the name of the field in the multipart form corresponding to
- * this file item.
+ * Returns the name of the field in the multipart form corresponding to this file item.
*
* @return The name of the form field.
* @see #setFieldName(java.lang.String)
@@ -380,7 +377,8 @@ public String getFieldName() {
/**
* Sets the field name used to reference this file item.
*
- * @param fieldName The name of the form field.
+ * @param fieldName
+ * The name of the form field.
* @see #getFieldName()
*/
@Override
@@ -389,11 +387,10 @@ public void setFieldName(String fieldName) {
}
/**
- * Determines whether or not a FileItem instance represents
- * a simple form field.
+ * Determines whether or not a FileItem instance represents a simple form field.
*
- * @return true if the instance represents a simple form
- * field; false if it represents an uploaded file.
+ * @return true if the instance represents a simple form field; false if it represents
+ * an uploaded file.
* @see #setFormField(boolean)
*/
@Override
@@ -402,11 +399,11 @@ public boolean isFormField() {
}
/**
- * Specifies whether or not a FileItem instance represents
- * a simple form field.
+ * Specifies whether or not a FileItem instance represents a simple form field.
*
- * @param state true if the instance represents a simple form
- * field; false if it represents an uploaded file.
+ * @param state
+ * true if the instance represents a simple form field; false if it
+ * represents an uploaded file.
* @see #isFormField()
*/
@Override
@@ -415,12 +412,11 @@ public void setFormField(boolean state) {
}
/**
- * Returns an {@link java.io.OutputStream OutputStream} that can
- * be used for storing the contents of the file.
+ * Returns an {@link java.io.OutputStream OutputStream} that can be used for storing the contents of the file.
*
- * @return An {@link java.io.OutputStream OutputStream} that can be used
- * for storing the contents of the file.
- * @throws IOException if an error occurs.
+ * @return An {@link java.io.OutputStream OutputStream} that can be used for storing the contents of the file.
+ * @throws IOException
+ * if an error occurs.
*/
@Override
public OutputStream getOutputStream() throws IOException {
@@ -436,17 +432,13 @@ public OutputStream getOutputStream() throws IOException {
// --------------------------------------------------------- Public methods
/**
- * Returns the {@link java.io.File} object for the FileItem's
- * data's temporary location on the disk. Note that for
- * FileItems that have their data stored in memory,
- * this method will return null. When handling large
- * files, you can use {@link java.io.File#renameTo(java.io.File)} to
- * move the file to new location without copying the data, if the
- * source and destination locations reside within the same logical
- * volume.
+ * Returns the {@link java.io.File} object for the FileItem's data's temporary location on the
+ * disk. Note that for FileItems that have their data stored in memory, this method will return
+ * null. When handling large files, you can use {@link java.io.File#renameTo(java.io.File)} to move
+ * the file to new location without copying the data, if the source and destination locations reside within the
+ * same logical volume.
*
- * @return The data file, or null if the data is stored in
- * memory.
+ * @return The data file, or null if the data is stored in memory.
*/
public File getStoreLocation() {
return dfos.getFile();
@@ -454,10 +446,9 @@ public File getStoreLocation() {
// ------------------------------------------------------ Protected methods
/**
- * Creates and returns a {@link java.io.File File} representing a uniquely
- * named temporary file in the configured repository path. The lifetime of
- * the file is tied to the lifetime of the FileItem instance;
- * the file will be deleted when the instance is garbage collected.
+ * Creates and returns a {@link java.io.File File} representing a uniquely named temporary file in the
+ * configured repository path. The lifetime of the file is tied to the lifetime of the FileItem
+ * instance; the file will be deleted when the instance is garbage collected.
*
* @return The {@link java.io.File File} to be used for temporary storage.
*/
@@ -476,8 +467,8 @@ protected File getTempFile() {
// -------------------------------------------------------- Private methods
/**
- * Returns an identifier that is unique within the class loader used to
- * load this class, but does not have random-like apearance.
+ * Returns an identifier that is unique within the class loader used to load this class, but does not have
+ * random-like apearance.
*
* @return A String with the non-random looking instance identifier.
*/
@@ -496,12 +487,14 @@ private static String getUniqueId() {
return id;
}
+ @Override
public String toString() {
- return "name=" + this.getName() + ", StoreLocation=" + String.valueOf(this.getStoreLocation()) + ", size=" + this.getSize() + "bytes, " + "isFormField=" + isFormField() + ", FieldName=" + this.getFieldName();
+ return "name=" + this.getName() + ", StoreLocation=" + String.valueOf(this.getStoreLocation()) + ", size=" + this.getSize()
+ + "bytes, " + "isFormField=" + isFormField() + ", FieldName=" + this.getFieldName();
}
/**
- * Returns the file item headers.
+ * Returns the file item headers.
*
* @return The file items headers.
*/
@@ -518,7 +511,7 @@ public FileItemHeaders getHeaders() {
*/
@Override
public void setHeaders(FileItemHeaders pHeaders) {
- headers = pHeaders;
+ headers = pHeaders;
}
}
@@ -526,7 +519,8 @@ public void setHeaders(FileItemHeaders pHeaders) {
public Map parse(InputStream body) {
Map result = new HashMap<>();
try {
- FileItemIteratorImpl iter = new FileItemIteratorImpl(body, Request.current().headers.get("content-type").value(), Request.current().encoding);
+ FileItemIteratorImpl iter = new FileItemIteratorImpl(body, Request.current().headers.get("content-type").value(),
+ Request.current().encoding);
while (iter.hasNext()) {
FileItemStream item = iter.next();
FileItem fileItem = new AutoFileItem(item);
@@ -542,16 +536,17 @@ public Map parse(InputStream body) {
// must resolve encoding
String _encoding = Request.current().encoding; // this is our default
String _contentType = fileItem.getContentType();
- if( _contentType != null ) {
+ if (_contentType != null) {
HTTP.ContentTypeWithEncoding contentTypeEncoding = HTTP.parseContentType(_contentType);
- if( contentTypeEncoding.encoding != null ) {
+ if (contentTypeEncoding.encoding != null) {
_encoding = contentTypeEncoding.encoding;
}
}
- putMapEntry(result, fileItem.getFieldName(), fileItem.getString( _encoding ));
+ putMapEntry(result, fileItem.getFieldName(), fileItem.getString(_encoding));
} else {
- @SuppressWarnings("unchecked") List uploads = (List) Request.current().args.get("__UPLOADS");
+ @SuppressWarnings("unchecked")
+ List uploads = (List) Request.current().args.get("__UPLOADS");
if (uploads == null) {
uploads = new ArrayList<>();
Request.current().args.put("__UPLOADS", uploads);
@@ -564,8 +559,7 @@ public Map parse(InputStream body) {
}
putMapEntry(result, fileItem.getFieldName(), fileItem.getFieldName());
}
- }
- finally {
+ } finally {
fileItem.delete();
}
}
@@ -577,8 +571,9 @@ public Map parse(InputStream body) {
throw new UnexpectedException(e);
}
return result;
- } // ---------------------------------------------------------- Class methods
- // ----------------------------------------------------- Manifest constants
+ } // ---------------------------------------------------------- Class methods
+ // ----------------------------------------------------- Manifest constants
+
/**
* HTTP content type header name.
*/
@@ -609,13 +604,13 @@ public Map parse(InputStream body) {
private static final String MULTIPART_MIXED = "multipart/mixed";
// ----------------------------------------------------------- Data members
/**
- * The maximum size permitted for the complete request, as opposed to
- * {@link #fileSizeMax}. A value of -1 indicates no maximum.
+ * The maximum size permitted for the complete request, as opposed to {@link #fileSizeMax}. A value of -1 indicates
+ * no maximum.
*/
private long sizeMax = -1;
/**
- * The maximum size permitted for a single uploaded file, as opposed to
- * {@link #sizeMax}. A value of -1 indicates no maximum.
+ * The maximum size permitted for a single uploaded file, as opposed to {@link #sizeMax}. A value of -1 indicates no
+ * maximum.
*/
private long fileSizeMax = -1;
@@ -624,8 +619,8 @@ public Map parse(InputStream body) {
/**
* Retrieves the boundary from the Content-type header.
*
- * @param contentType The value of the content type header from which to extract the
- * boundary value.
+ * @param contentType
+ * The value of the content type header from which to extract the boundary value.
* @return The boundary, as a byte array.
*/
private byte[] getBoundary(String contentType) {
@@ -634,7 +629,7 @@ private byte[] getBoundary(String contentType) {
parser.setLowerCaseNames(true);
// Parameter parser can handle null input
Map params = parser.parse(contentType, ';');
- String boundaryStr = (String) params.get("boundary");
+ String boundaryStr = params.get("boundary");
if (boundaryStr == null) {
return null;
@@ -649,10 +644,10 @@ private byte[] getBoundary(String contentType) {
}
/**
- * Retrieves the file name from the Content-disposition
- * header.
+ * Retrieves the file name from the Content-disposition header.
*
- * @param headers A Map containing the HTTP request headers.
+ * @param headers
+ * A Map containing the HTTP request headers.
* @return The file name for the current encapsulation.
*/
private String getFileName(Map headers) {
@@ -687,17 +682,16 @@ private String getFileName(Map headers) {
}
/**
- * Retrieves the field name from the Content-disposition
- * header.
+ * Retrieves the field name from the Content-disposition header.
*
- * @param headers A Map containing the HTTP request headers.
+ * @param headers
+ * A Map containing the HTTP request headers.
* @return The field name for the current encapsulation.
*/
private String getFieldName(Map headers) {
String fieldName = null;
String cd = getHeader(headers, CONTENT_DISPOSITION);
- if (cd != null && (cd.toLowerCase().startsWith(FORM_DATA) ||
- cd.toLowerCase().startsWith(ATTACHMENT))) {
+ if (cd != null && (cd.toLowerCase().startsWith(FORM_DATA) || cd.toLowerCase().startsWith(ATTACHMENT))) {
ParameterParser parser = new ParameterParser();
parser.setLowerCaseNames(true);
@@ -716,18 +710,18 @@ private String getFieldName(Map headers) {
* Parses the header-part and returns as key/value pairs.
*
*
- * If there are multiple headers of the same names, the name will map to a
- * comma-separated list containing the values.
+ * If there are multiple headers of the same names, the name will map to a comma-separated list containing the
+ * values.
*
- * @param headerPart The header-part of the current
- * encapsulation.
+ * @param headerPart
+ * The header-part of the current encapsulation.
* @return A Map containing the parsed HTTP request headers.
*/
private Map parseHeaders(String headerPart) {
int len = headerPart.length();
Map headers = new HashMap<>();
int start = 0;
- for (; ;) {
+ for (;;) {
int end = parseEndOfLine(headerPart, start);
if (start == end) {
break;
@@ -759,13 +753,15 @@ private Map parseHeaders(String headerPart) {
/**
* Skips bytes until the end of the current line.
*
- * @param headerPart The headers, which are being parsed.
- * @param end Index of the last byte, which has yet been processed.
+ * @param headerPart
+ * The headers, which are being parsed.
+ * @param end
+ * Index of the last byte, which has yet been processed.
* @return Index of the \r\n sequence, which indicates end of line.
*/
private int parseEndOfLine(String headerPart, int end) {
int index = end;
- for (; ;) {
+ for (;;) {
int offset = headerPart.indexOf('\r', index);
if (offset == -1 || offset + 1 >= headerPart.length()) {
throw new IllegalStateException("Expected headers to be terminated by an empty line.");
@@ -780,8 +776,10 @@ private int parseEndOfLine(String headerPart, int end) {
/**
* Reads the next header line.
*
- * @param headers String with all headers.
- * @param header Map where to store the current header.
+ * @param headers
+ * String with all headers.
+ * @param header
+ * Map where to store the current header.
*/
private void parseHeaderLine(Map headers, String header) {
int colonOffset = header.indexOf(':');
@@ -801,21 +799,20 @@ private void parseHeaderLine(Map headers, String header) {
}
/**
- * Returns the header with the specified name from the supplied map. The
- * header lookup is case-insensitive.
+ * Returns the header with the specified name from the supplied map. The header lookup is case-insensitive.
*
- * @param headers A Map containing the HTTP request headers.
- * @param name The name of the header to return.
- * @return The value of specified header, or a comma-separated list if there
- * were multiple headers of that name.
+ * @param headers
+ * A Map containing the HTTP request headers.
+ * @param name
+ * The name of the header to return.
+ * @return The value of specified header, or a comma-separated list if there were multiple headers of that name.
*/
private String getHeader(Map headers, String name) {
return headers.get(name.toLowerCase());
}
/**
- * The iterator, which is returned by
- * {@link FileUploadBase#getItemIterator(RequestContext)}.
+ * The iterator, which is returned by {@link FileUploadBase#getItemIterator(RequestContext)}.
*/
private class FileItemIteratorImpl implements FileItemIterator {
@@ -854,10 +851,14 @@ private class FileItemStreamImpl implements FileItemStream {
/**
* CReates a new instance.
*
- * @param pName The items file name, or null.
- * @param pFieldName The items field name.
- * @param pContentType The items content type, or null.
- * @param pFormField Whether the item is a form field.
+ * @param pName
+ * The items file name, or null.
+ * @param pFieldName
+ * The items field name.
+ * @param pContentType
+ * The items content type, or null.
+ * @param pFormField
+ * Whether the item is a form field.
*/
FileItemStreamImpl(String pName, String pFieldName, String pContentType, boolean pFormField) {
name = pName;
@@ -870,7 +871,9 @@ private class FileItemStreamImpl implements FileItemStream {
@Override
protected void raiseError(long pSizeMax, long pCount) throws IOException {
- FileUploadException e = new FileSizeLimitExceededException("The field " + fieldName + " exceeds its maximum permitted " + " size of " + pSizeMax + " characters.", pCount, pSizeMax);
+ FileUploadException e = new FileSizeLimitExceededException(
+ "The field " + fieldName + " exceeds its maximum permitted " + " size of " + pSizeMax + " characters.",
+ pCount, pSizeMax);
throw new FileUploadIOException(e);
}
};
@@ -888,7 +891,6 @@ public void setHeaders(FileItemHeaders fileItemHeaders) {
this.fileItemHeaders = fileItemHeaders;
}
-
/**
* Returns the items content type, or null.
*
@@ -930,11 +932,11 @@ public boolean isFormField() {
}
/**
- * Returns an input stream, which may be used to read the items
- * contents.
+ * Returns an input stream, which may be used to read the items contents.
*
* @return Opened input stream.
- * @throws IOException An I/O error occurred.
+ * @throws IOException
+ * An I/O error occurred.
*/
@Override
public InputStream openStream() throws IOException {
@@ -950,7 +952,8 @@ public InputStream openStream() throws IOException {
/**
* Closes the file item.
*
- * @throws IOException An I/O error occurred.
+ * @throws IOException
+ * An I/O error occurred.
*/
void close() throws IOException {
stream.close();
@@ -989,13 +992,16 @@ void close() throws IOException {
/**
* Creates a new instance.
*
- * @throws FileUploadException An error occurred while parsing the request.
- * @throws IOException An I/O error occurred.
+ * @throws FileUploadException
+ * An error occurred while parsing the request.
+ * @throws IOException
+ * An I/O error occurred.
*/
FileItemIteratorImpl(InputStream input, String contentType, String charEncoding) throws FileUploadException, IOException {
if ((null == contentType) || (!contentType.toLowerCase().startsWith(MULTIPART))) {
- throw new InvalidContentTypeException("the request doesn't contain a " + MULTIPART_FORM_DATA + " or " + MULTIPART_MIXED + " stream, content type header is " + contentType);
+ throw new InvalidContentTypeException("the request doesn't contain a " + MULTIPART_FORM_DATA + " or " + MULTIPART_MIXED
+ + " stream, content type header is " + contentType);
}
if (sizeMax >= 0) {
@@ -1005,7 +1011,8 @@ void close() throws IOException {
@Override
protected void raiseError(long pSizeMax, long pCount) throws IOException {
- FileUploadException ex = new SizeLimitExceededException("the request was rejected because" + " its size (" + pCount + ") exceeds the configured maximum" + " (" + pSizeMax + ")", pCount, pSizeMax);
+ FileUploadException ex = new SizeLimitExceededException("the request was rejected because" + " its size (" + pCount
+ + ") exceeds the configured maximum" + " (" + pSizeMax + ")", pCount, pSizeMax);
throw new FileUploadIOException(ex);
}
};
@@ -1028,7 +1035,8 @@ protected void raiseError(long pSizeMax, long pCount) throws IOException {
* Called for finding the nex item, if any.
*
* @return True, if an next item was found, otherwise false.
- * @throws IOException An I/O error occurred.
+ * @throws IOException
+ * An I/O error occurred.
*/
private boolean findNextItem() throws IOException {
if (eof) {
@@ -1038,7 +1046,7 @@ private boolean findNextItem() throws IOException {
currentItem.close();
currentItem = null;
}
- for (; ;) {
+ for (;;) {
boolean nextPart;
if (skipPreamble) {
nextPart = multi.skipPreamble();
@@ -1089,13 +1097,13 @@ private boolean findNextItem() throws IOException {
}
/**
- * Returns, whether another instance of {@link FileItemStream} is
- * available.
+ * Returns, whether another instance of {@link FileItemStream} is available.
*
- * @return True, if one or more additional file items are available,
- * otherwise false.
- * @throws FileUploadException Parsing or processing the file item failed.
- * @throws IOException Reading the file item failed.
+ * @return True, if one or more additional file items are available, otherwise false.
+ * @throws FileUploadException
+ * Parsing or processing the file item failed.
+ * @throws IOException
+ * Reading the file item failed.
*/
@Override
public boolean hasNext() throws FileUploadException, IOException {
@@ -1111,13 +1119,13 @@ public boolean hasNext() throws FileUploadException, IOException {
/**
* Returns the next available {@link FileItemStream}.
*
- * @return FileItemStream instance, which provides access to the next
- * file item.
+ * @return FileItemStream instance, which provides access to the next file item.
* @throws java.util.NoSuchElementException
- * No more items are available. Use {@link #hasNext()} to
- * prevent this exception.
- * @throws FileUploadException Parsing or processing the file item failed.
- * @throws IOException Reading the file item failed.
+ * No more items are available. Use {@link #hasNext()} to prevent this exception.
+ * @throws FileUploadException
+ * Parsing or processing the file item failed.
+ * @throws IOException
+ * Reading the file item failed.
*/
@Override
public FileItemStream next() throws FileUploadException, IOException {
@@ -1130,8 +1138,7 @@ public FileItemStream next() throws FileUploadException, IOException {
}
/**
- * This exception is thrown for hiding an inner {@link FileUploadException}
- * in an {@link IOException}.
+ * This exception is thrown for hiding an inner {@link FileUploadException} in an {@link IOException}.
*/
private static class FileUploadIOException extends IOException {
@@ -1140,15 +1147,15 @@ private static class FileUploadIOException extends IOException {
*/
private static final long serialVersionUID = -7047616958165584154L;
/**
- * The exceptions cause; we overwrite the parent classes field, which is
- * available since Java 1.4 only.
+ * The exceptions cause; we overwrite the parent classes field, which is available since Java 1.4 only.
*/
private final FileUploadException cause;
/**
* Creates a FileUploadIOException with the given cause.
*
- * @param pCause The exceptions cause, if any, or null.
+ * @param pCause
+ * The exceptions cause, if any, or null.
*/
public FileUploadIOException(FileUploadException pCause) {
// We're not doing super(pCause) cause of 1.3 compatibility.
@@ -1177,10 +1184,10 @@ private static class InvalidContentTypeException extends FileUploadException {
private static final long serialVersionUID = -9073026332015646668L;
/**
- * Constructs an InvalidContentTypeException with the
- * specified detail message.
+ * Constructs an InvalidContentTypeException with the specified detail message.
*
- * @param message The detail message.
+ * @param message
+ * The detail message.
*/
public InvalidContentTypeException(String message) {
super(message);
@@ -1197,16 +1204,17 @@ private static class IOFileUploadException extends FileUploadException {
*/
private static final long serialVersionUID = 1749796615868477269L;
/**
- * The exceptions cause; we overwrite the parent classes field, which is
- * available since Java 1.4 only.
+ * The exceptions cause; we overwrite the parent classes field, which is available since Java 1.4 only.
*/
private final IOException cause;
/**
* Creates a new instance with the given cause.
*
- * @param pMsg The detail message.
- * @param pException The exceptions cause.
+ * @param pMsg
+ * The detail message.
+ * @param pException
+ * The exceptions cause.
*/
public IOFileUploadException(String pMsg, IOException pException) {
super(pMsg);
@@ -1241,9 +1249,12 @@ protected abstract static class SizeException extends FileUploadException {
/**
* Creates a new instance.
*
- * @param message The detail message.
- * @param actual The actual number of bytes in the request.
- * @param permitted The requests size limit, in bytes.
+ * @param message
+ * The detail message.
+ * @param actual
+ * The actual number of bytes in the request.
+ * @param permitted
+ * The requests size limit, in bytes.
*/
protected SizeException(String message, long actual, long permitted) {
super(message);
@@ -1281,12 +1292,15 @@ private static class SizeLimitExceededException extends SizeException {
private static final long serialVersionUID = -2474893167098052828L;
/**
- * Constructs a SizeExceededException with the specified
- * detail message, and actual and permitted sizes.
+ * Constructs a SizeExceededException with the specified detail message, and actual and permitted
+ * sizes.
*
- * @param message The detail message.
- * @param actual The actual request size.
- * @param permitted The maximum permitted request size.
+ * @param message
+ * The detail message.
+ * @param actual
+ * The actual request size.
+ * @param permitted
+ * The maximum permitted request size.
*/
public SizeLimitExceededException(String message, long actual, long permitted) {
super(message, actual, permitted);
@@ -1304,12 +1318,15 @@ private static class FileSizeLimitExceededException extends SizeException {
private static final long serialVersionUID = 8150776562029630058L;
/**
- * Constructs a SizeExceededException with the specified
- * detail message, and actual and permitted sizes.
+ * Constructs a SizeExceededException with the specified detail message, and actual and permitted
+ * sizes.
*
- * @param message The detail message.
- * @param actual The actual request size.
- * @param permitted The maximum permitted request size.
+ * @param message
+ * The detail message.
+ * @param actual
+ * The actual request size.
+ * @param permitted
+ * The maximum permitted request size.
*/
public FileSizeLimitExceededException(String message, long actual, long permitted) {
super(message, actual, permitted);
diff --git a/framework/src/play/data/validation/Equals.java b/framework/src/play/data/validation/Equals.java
index 24e112269f..f0b9d228ce 100644
--- a/framework/src/play/data/validation/Equals.java
+++ b/framework/src/play/data/validation/Equals.java
@@ -4,24 +4,23 @@
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
+
import net.sf.oval.configuration.annotation.Constraint;
/**
- * This field must be equals to another field.
- * Message key: validation.equals
- * $1: field name
- * $2: other field name
+ * This field must be equals to another field. Message key: validation.equals $1: field name $2: other field name
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.FIELD, ElementType.PARAMETER})
+@Target({ ElementType.FIELD, ElementType.PARAMETER })
@Constraint(checkWith = EqualsCheck.class)
public @interface Equals {
String message() default EqualsCheck.mes;
-
+
/**
* The other field name
+ *
+ * @return The other field name
*/
String value();
}
-
diff --git a/framework/src/play/db/Configuration.java b/framework/src/play/db/Configuration.java
index a691a6b0fe..ffb2a6f8e3 100644
--- a/framework/src/play/db/Configuration.java
+++ b/framework/src/play/db/Configuration.java
@@ -1,80 +1,88 @@
package play.db;
-import java.util.*;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Properties;
+import java.util.Set;
+import java.util.TreeSet;
-import play.*;
import jregex.Matcher;
import jregex.Pattern;
+import play.Play;
public class Configuration {
-
+
public String configName;
-
-
- public boolean isDefault(){
+
+ public boolean isDefault() {
return DB.DEFAULT.equals(this.configName);
}
-
- public Configuration(String configurationName){
+
+ public Configuration(String configurationName) {
this.configName = configurationName;
}
-
-
- public static Set getDbNames() {
- TreeSet dbNames = new TreeSet<>();
- // search for case db= or db.url= as at least one of these property is required
- String DB_CONFIG_PATTERN = "^db\\.([^\\.]*)$|^db\\.([^\\.]*)\\.url$";
- Pattern pattern = new jregex.Pattern(DB_CONFIG_PATTERN);
-
- // List of properties with 2 words
- List dbProperties = Arrays.asList("db.driver", "db.url", "db.user", "db.pass", "db.isolation", "db.destroyMethod", "db.testquery");
-
- for (String property : Play.configuration.stringPropertyNames()) {
- Matcher m = pattern.matcher(property);
- if (m.matches() && !dbProperties.contains(property)) {
- String dbName = (m.group(1) != null ? m.group(1) : m.group(2));
- dbNames.add(dbName);
- }
- // Special case db=... and
- if ("db".equals(property) || "db.url".equals(property)) {
- dbNames.add("default");
- }
- }
- return new TreeSet<>(dbNames);
- }
-
- public String getProperty(String key) {
- return this.getProperty(key, null);
- }
-
-
- public String getProperty(String key, String defaultString) {
- if (key != null) {
- String newKey = generateKey(key);
- Object value = Play.configuration.get(newKey);
- if (value == null && this.isDefault()){
- value = Play.configuration.get(key);
- }
- if (value != null){
- return value.toString();
- }
- }
-
- return defaultString;
- }
-
- /**
- *
- * @param key
- * @param value
- * @return the previous value of the specified key in this hashtable, or null if it did not have one
- */
- public Object put(String key, String value) {
- if (key != null) {
- return Play.configuration.put(generateKey(key), value);
- }
- return null;
- }
+
+ public static Set getDbNames() {
+ TreeSet dbNames = new TreeSet<>();
+ // search for case db= or db.url= as at least one of these property is required
+ String DB_CONFIG_PATTERN = "^db\\.([^\\.]*)$|^db\\.([^\\.]*)\\.url$";
+ Pattern pattern = new jregex.Pattern(DB_CONFIG_PATTERN);
+
+ // List of properties with 2 words
+ List dbProperties = Arrays.asList("db.driver", "db.url", "db.user", "db.pass", "db.isolation", "db.destroyMethod",
+ "db.testquery");
+
+ for (String property : Play.configuration.stringPropertyNames()) {
+ Matcher m = pattern.matcher(property);
+ if (m.matches() && !dbProperties.contains(property)) {
+ String dbName = (m.group(1) != null ? m.group(1) : m.group(2));
+ dbNames.add(dbName);
+ }
+ // Special case db=... and
+ if ("db".equals(property) || "db.url".equals(property)) {
+ dbNames.add("default");
+ }
+ }
+ return new TreeSet<>(dbNames);
+ }
+
+ public String getProperty(String key) {
+ return this.getProperty(key, null);
+ }
+
+ public String getProperty(String key, String defaultString) {
+ if (key != null) {
+ String newKey = generateKey(key);
+ Object value = Play.configuration.get(newKey);
+ if (value == null && this.isDefault()) {
+ value = Play.configuration.get(key);
+ }
+ if (value != null) {
+ return value.toString();
+ }
+ }
+
+ return defaultString;
+ }
+
+ /**
+ * Add a parameter in the configuration
+ *
+ * @param key
+ * the key of the parameter
+ * @param value
+ * the value of the parameter
+ * @return the previous value of the specified key in this hashtable, or null if it did not have one
+ */
+ public Object put(String key, String value) {
+ if (key != null) {
+ return Play.configuration.put(generateKey(key), value);
+ }
+ return null;
+ }
String generateKey(String key) {
Pattern pattern = new Pattern("^(db|jpa|hibernate){1}(\\.?[\\da-zA-Z\\.-_]*)$");
@@ -85,36 +93,35 @@ String generateKey(String key) {
return key;
}
-
public Map getProperties() {
Map properties = new HashMap<>();
Properties props = Play.configuration;
-
+
for (Object key : Collections.list(props.keys())) {
String keyName = key.toString();
- if (keyName.startsWith("db") || keyName.startsWith("hibernate") ) {
- if (keyName.startsWith("db." + this.configName) || keyName.startsWith("hibernate." + this.configName) ) {
+ if (keyName.startsWith("db") || keyName.startsWith("hibernate")) {
+ if (keyName.startsWith("db." + this.configName) || keyName.startsWith("hibernate." + this.configName)) {
String type = keyName.substring(0, keyName.indexOf('.'));
String newKey = type;
- if(keyName.length() > (type + "." + this.configName).length()){
- newKey += "." + keyName.substring((type + "." + this.configName).length() + 1);
+ if (keyName.length() > (type + "." + this.configName).length()) {
+ newKey += "." + keyName.substring((type + "." + this.configName).length() + 1);
}
properties.put(newKey, props.get(key).toString());
- }else if(this.isDefault()){
- boolean isDefaultProperty = true;
+ } else if (this.isDefault()) {
+ boolean isDefaultProperty = true;
Set dBNames = Configuration.getDbNames();
- for(String dbName : dBNames){
- if(key.toString().startsWith("db." + dbName) || key.toString().startsWith("hibernate." + dbName)){
+ for (String dbName : dBNames) {
+ if (key.toString().startsWith("db." + dbName) || key.toString().startsWith("hibernate." + dbName)) {
isDefaultProperty = false;
break;
}
}
- if(isDefaultProperty){
+ if (isDefaultProperty) {
properties.put(key.toString(), props.get(key).toString());
}
}
}
- }
+ }
return properties;
}
}
diff --git a/framework/src/play/db/DB.java b/framework/src/play/db/DB.java
index 4f49c15d63..ce043bcf6c 100644
--- a/framework/src/play/db/DB.java
+++ b/framework/src/play/db/DB.java
@@ -9,6 +9,7 @@
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
import javax.sql.DataSource;
import javax.sql.RowSet;
@@ -18,11 +19,9 @@
import com.sun.rowset.CachedRowSetImpl;
+import play.Logger;
import play.db.jpa.JPA;
import play.exceptions.DatabaseException;
-import play.Logger;
-
-import java.util.concurrent.ConcurrentHashMap;
/**
* Database connection utilities.
@@ -31,6 +30,7 @@ public class DB {
/**
* The loaded datasource.
+ *
* @see ExtendedDatasource
*/
protected static final Map datasources = new ConcurrentHashMap<>();
@@ -147,6 +147,9 @@ public static void close() {
/**
* Close an given open connections for the current thread
+ *
+ * @param name
+ * Name of the DB
*/
public static void close(String name) {
Map map = localConnection.get();
@@ -158,8 +161,7 @@ public static void close(String name) {
try {
connection.close();
} catch (Exception e) {
- throw new DatabaseException("It's possible than the connection '" + name
- + "'was not properly closed !", e);
+ throw new DatabaseException("It's possible than the connection '" + name + "'was not properly closed !", e);
}
}
}
@@ -168,6 +170,8 @@ public static void close(String name) {
/**
* Open a connection for the current thread.
*
+ * @param name
+ * Name of the DB
* @return A valid SQL connection
*/
public static Connection getConnection(String name) {
@@ -202,10 +206,13 @@ public static Connection getConnection() {
/**
* Execute an SQL update
- *
+ *
+ * @param name
+ * the DB name
* @param SQL
- * @return true if the next result is a ResultSet object; false if it is an
- * update count or there are no more results
+ * the SQL statement
+ * @return true if the next result is a ResultSet object; false if it is an update count or there are no more
+ * results
*/
public static boolean execute(String name, String SQL) {
Statement statement = null;
@@ -222,10 +229,25 @@ public static boolean execute(String name, String SQL) {
return false;
}
+ /**
+ * Execute an SQL update
+ *
+ * @param SQL
+ * the SQL statement
+ * @return true if the next result is a ResultSet object; false if it is an update count or there are no more
+ * results
+ */
public static boolean execute(String SQL) {
return execute(DEFAULT, SQL);
}
+ /**
+ * Execute an SQL query
+ *
+ * @param SQL
+ * the SQL statement
+ * @return The ResultSet object; false if it is an update count or there are no more results
+ */
public static RowSet executeQuery(String SQL) {
return executeQuery(DEFAULT, SQL);
}
@@ -233,7 +255,10 @@ public static RowSet executeQuery(String SQL) {
/**
* Execute an SQL query
*
+ * @param name
+ * the DB name
* @param SQL
+ * the SQL statement
* @return The rowSet of the query
*/
public static RowSet executeQuery(String name, String SQL) {
@@ -281,13 +306,15 @@ public static void safeCloseStatement(Statement statement) {
/**
* Destroy the datasource
+ *
+ * @param name
+ * the DB name
*/
public static void destroy(String name) {
try {
ExtendedDatasource extDatasource = datasources.get(name);
if (extDatasource != null && extDatasource.getDestroyMethod() != null) {
- Method close = extDatasource.datasource.getClass().getMethod(extDatasource.getDestroyMethod(),
- new Class[] {});
+ Method close = extDatasource.datasource.getClass().getMethod(extDatasource.getDestroyMethod(), new Class[] {});
if (close != null) {
close.invoke(extDatasource.getDataSource(), new Object[] {});
datasources.remove(name);
diff --git a/framework/src/play/db/Evolutions.java b/framework/src/play/db/Evolutions.java
index e7d082a55e..94256f2605 100644
--- a/framework/src/play/db/Evolutions.java
+++ b/framework/src/play/db/Evolutions.java
@@ -6,7 +6,6 @@
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Collections;
-import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
@@ -151,11 +150,11 @@ public static void main(String[] args) throws SQLException {
* Method to handle the "default" action
*
* @param dbName
- * : database name
+ * database name
* @param moduleRoot
- * : the module root of evolutions
+ * the module root of evolutions
* @param evolutions
- * : list of evolutions
+ * list of evolutions
*/
private static void handleDefaultAction(String dbName, Entry moduleRoot, List evolutions) {
System.out.println("~ Your database " + dbName + " needs evolutions for " + moduleRoot.getKey() + "!");
@@ -175,9 +174,9 @@ private static void handleDefaultAction(String dbName, Entry moduleRoot) {
@@ -202,11 +201,11 @@ private static boolean handleResolveAction(String dbName, Entry moduleRoot, List evolutions) {
@@ -235,11 +234,11 @@ private static boolean handleApplyAction(String dbName, Entry moduleRoot, List evolutions) {
@@ -387,8 +386,7 @@ public void onApplicationStart() {
}
/**
- * Checks if evolutions is disabled in application.conf (property
- * "evolutions.enabled")
+ * Checks if evolutions is disabled in application.conf (property "evolutions.enabled")
*/
private boolean isDisabled() {
return "false".equals(Play.configuration.getProperty("evolutions.enabled", "true"));
@@ -578,7 +576,7 @@ public static synchronized List getEvolutionScript(String dbName, Str
}
public static synchronized Stack listApplicationEvolutions(String dBName, String moduleKey,
- VirtualFile evolutionsDirectory) {
+ VirtualFile evolutionsDirectory) {
Stack evolutions = new Stack<>();
evolutions.add(new Evolution("", 0, "", "", true));
if (evolutionsDirectory.exists()) {
diff --git a/framework/src/play/db/SQLSplitter.java b/framework/src/play/db/SQLSplitter.java
index 946413cc4d..dd1117a71f 100644
--- a/framework/src/play/db/SQLSplitter.java
+++ b/framework/src/play/db/SQLSplitter.java
@@ -1,58 +1,64 @@
package play.db;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.NoSuchElementException;
public class SQLSplitter implements Iterable {
/**
* Skips the index past the quote.
*
- * @param s The string
- * @param start The starting character of the quote.
- * @return The index that skips past the quote starting at start. If the quote does not start at that point, it simply returns start.
+ * @param s
+ * The string
+ * @param start
+ * The starting character of the quote.
+ * @return The index that skips past the quote starting at start. If the quote does not start at that point, it
+ * simply returns start.
*/
static int consumeQuote(CharSequence s, int start) {
- if (start >= s.length()) return start;
+ if (start >= s.length())
+ return start;
char ender;
switch (s.charAt(start)) {
- case '\'':
- ender = '\'';
- break;
- case '"':
- ender = '"';
- break;
- case '[':
- ender = ']';
- break;
-
- case '`':
- ender = '`';
- break;
- case '$': {
- int quoteEnd = start + 1;
- for (; s.charAt(quoteEnd) != '$'; ++quoteEnd)
- if (quoteEnd >= s.length())
- return quoteEnd;
- int i = quoteEnd + 1;
- while (i < s.length()) {
- if (s.charAt(i) == '$') {
- boolean match = true;
- for (int j = start; j <= quoteEnd && i < s.length(); ++j, ++i) {
- if (s.charAt(i) != s.charAt(j)) {
- match = false;
- break;
- }
+ case '\'':
+ ender = '\'';
+ break;
+ case '"':
+ ender = '"';
+ break;
+ case '[':
+ ender = ']';
+ break;
+
+ case '`':
+ ender = '`';
+ break;
+ case '$': {
+ int quoteEnd = start + 1;
+ for (; s.charAt(quoteEnd) != '$'; ++quoteEnd)
+ if (quoteEnd >= s.length())
+ return quoteEnd;
+ int i = quoteEnd + 1;
+ while (i < s.length()) {
+ if (s.charAt(i) == '$') {
+ boolean match = true;
+ for (int j = start; j <= quoteEnd && i < s.length(); ++j, ++i) {
+ if (s.charAt(i) != s.charAt(j)) {
+ match = false;
+ break;
}
- if (match)
- return i;
- } else
- ++i;
- }
- return i;
+ }
+ if (match)
+ return i;
+ } else
+ ++i;
}
+ return i;
+ }
- default:
- return start;
+ default:
+ return start;
}
boolean escaped = false;
@@ -95,66 +101,72 @@ static boolean isNext(CharSequence s, int start, char c) {
/**
* Skips the index past the comment.
*
- * @param s The string
- * @param start The starting character of the comment
- * @return The index that skips past the comment starting at start. If the comment does not start at that point, it simply returns start.
+ * @param s
+ * The string
+ * @param start
+ * The starting character of the comment
+ * @return The index that skips past the comment starting at start. If the comment does not start at that point, it
+ * simply returns start.
*/
static int consumeComment(CharSequence s, int start) {
- if (start >= s.length()) return start;
+ if (start >= s.length())
+ return start;
switch (s.charAt(start)) {
- case '-':
- if (isNext(s, start, '-'))
- return consumeTillNextLine(s, start + 2);
- else
- return start;
-
- case '#':
- return consumeTillNextLine(s, start);
-
- case '/':
- if (isNext(s, start, '*')) {
- start += 2;
- while (start < s.length()) {
- if (s.charAt(start) == '*') {
- ++start;
- if (start < s.length() && s.charAt(start) == '/')
- return start + 1;
- } else
- ++start;
- }
- }
+ case '-':
+ if (isNext(s, start, '-'))
+ return consumeTillNextLine(s, start + 2);
+ else
return start;
- case '{':
- while (start < s.length() && s.charAt(start) != '}')
- ++start;
- return start + 1;
+ case '#':
+ return consumeTillNextLine(s, start);
- default:
- return start;
+ case '/':
+ if (isNext(s, start, '*')) {
+ start += 2;
+ while (start < s.length()) {
+ if (s.charAt(start) == '*') {
+ ++start;
+ if (start < s.length() && s.charAt(start) == '/')
+ return start + 1;
+ } else
+ ++start;
+ }
+ }
+ return start;
+
+ case '{':
+ while (start < s.length() && s.charAt(start) != '}')
+ ++start;
+ return start + 1;
+
+ default:
+ return start;
}
}
static int consumeParentheses(CharSequence s, int start) {
- if (start >= s.length()) return start;
+ if (start >= s.length())
+ return start;
switch (s.charAt(start)) {
- case '(':
- ++start;
- while (start < s.length()) {
- if (s.charAt(start) == ')')
- return start + 1;
- start = nextChar(s, start);
- }
- break;
- default:
- break;
+ case '(':
+ ++start;
+ while (start < s.length()) {
+ if (s.charAt(start) == ')')
+ return start + 1;
+ start = nextChar(s, start);
+ }
+ break;
+ default:
+ break;
}
return start;
}
static int nextChar(CharSequence sql, int start) {
int i = consumeParentheses(sql, consumeComment(sql, consumeQuote(sql, start)));
- if (i == start) return Math.min(start + 1, sql.length());
+ if (i == start)
+ return Math.min(start + 1, sql.length());
do {
int j = consumeParentheses(sql, consumeComment(sql, consumeQuote(sql, i)));
if (j == i)
@@ -165,6 +177,10 @@ static int nextChar(CharSequence sql, int start) {
/**
* Splits the SQL "properly" based on semicolons. Respecting quotes and comments.
+ *
+ * @param sql
+ * the SQL statement
+ * @return List of all SQL statements
*/
public static ArrayList splitSQL(CharSequence sql) {
ArrayList ret = new ArrayList<>();
diff --git a/framework/src/play/db/jpa/GenericModel.java b/framework/src/play/db/jpa/GenericModel.java
index 1b7cebac20..f9031f9d4f 100644
--- a/framework/src/play/db/jpa/GenericModel.java
+++ b/framework/src/play/db/jpa/GenericModel.java
@@ -1,10 +1,30 @@
package play.db.jpa;
+import java.lang.annotation.Annotation;
+import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.ParameterizedType;
-import java.util.*;
-
-import javax.persistence.*;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.SortedSet;
+import java.util.TreeSet;
+
+import javax.persistence.ManyToMany;
+import javax.persistence.ManyToOne;
+import javax.persistence.MappedSuperclass;
+import javax.persistence.NoResultException;
+import javax.persistence.OneToMany;
+import javax.persistence.OneToOne;
+import javax.persistence.PostLoad;
+import javax.persistence.PostPersist;
+import javax.persistence.PostUpdate;
+import javax.persistence.Query;
import org.apache.commons.lang.StringUtils;
@@ -17,27 +37,50 @@
import play.exceptions.UnexpectedException;
import play.mvc.Scope.Params;
-import java.lang.annotation.Annotation;
-import java.lang.reflect.Constructor;
-
/**
- * A super class for JPA entities
+ * A super class for JPA entities
*/
@MappedSuperclass
@SuppressWarnings("unchecked")
public class GenericModel extends JPABase {
/**
- * This method is deprecated. Use this instead:
- *
- * public static <T extends JPABase> T create(ParamNode rootParamNode, String name, Class<?> type, Annotation[] annotations)
+ * Create a new model
+ *
+ * @param type
+ * the class of the object
+ * @param name
+ * name of the object
+ * @param params
+ * parameters used to create the new object
+ * @param annotations
+ * annotations on the model
+ * @param
+ * The entity class
+ * @return The created entity
+ * @deprecated use method {{@link #create(ParamNode, String, Class, Annotation[]) }}
*/
@Deprecated
public static T create(Class type, String name, Map params, Annotation[] annotations) {
ParamNode rootParamNode = ParamNode.convert(params);
- return (T)create(rootParamNode, name, type, annotations);
+ return (T) create(rootParamNode, name, type, annotations);
}
+ /**
+ * Create a new model
+ *
+ * @param rootParamNode
+ * parameters used to create the new object
+ * @param name
+ * name of the object
+ * @param type
+ * the class of the object
+ * @param annotations
+ * annotations on the model
+ * @param
+ * The entity class
+ * @return The created entity
+ */
public static T create(ParamNode rootParamNode, String name, Class type, Annotation[] annotations) {
try {
Constructor c = type.getDeclaredConstructor();
@@ -50,24 +93,65 @@ public static T create(ParamNode rootParamNode, String name,
}
/**
- * This method is deprecated. Use this instead:
- *
- * public static <T extends JPABase> T edit(ParamNode rootParamNode, String name, Object o, Annotation[] annotations)
- *
- * @see GenericModel#edit(ParamNode, String, Object, Annotation[])
+ * Edit a model
*
+ * @param o
+ * Object to edit
+ * @param name
+ * name of the object
+ * @param params
+ * list of parameters
+ * @param annotations
+ * annotations on the model
+ * @param
+ * class of the entity
* @return the entity
+ *
+ * @see GenericModel#edit(ParamNode, String, Object, Annotation[])
+ * @deprecated use method {{@link GenericModel#edit(ParamNode, String, Object, Annotation[]) }}
*/
@Deprecated
public static T edit(Object o, String name, Map params, Annotation[] annotations) {
ParamNode rootParamNode = ParamNode.convert(params);
- return (T)edit( rootParamNode, name, o, annotations);
+ return (T) edit(rootParamNode, name, o, annotations);
}
+ /**
+ * Edit a model
+ *
+ * @param rootParamNode
+ * parameters used to create the new object
+ * @param name
+ * name of the object
+ * @param o
+ * the entity to update
+ * @param annotations
+ * annotations on the model
+ * @param
+ * class of the entity
+ * @return the entity
+ */
public static T edit(ParamNode rootParamNode, String name, Object o, Annotation[] annotations) {
return edit(JPA.DEFAULT, rootParamNode, name, o, annotations);
}
+ /**
+ * Edit a model
+ *
+ * @param dbName
+ * the db name
+ * @param rootParamNode
+ * parameters used to create the new object
+ * @param name
+ * name of the object
+ * @param o
+ * the entity to update
+ * @param annotations
+ * annotations on the model
+ * @param
+ * class of the entity
+ * @return the entity
+ */
public static T edit(String dbName, ParamNode rootParamNode, String name, Object o, Annotation[] annotations) {
// #1601 - If name is empty, we're dealing with "root" request parameters (without prefixes).
// Must not call rootParamNode.getChild in that case, as it returns null. Use rootParamNode itself instead.
@@ -88,15 +172,16 @@ public static T edit(String dbName, ParamNode rootParamNode,
boolean isEntity = false;
String relation = null;
boolean multiple = false;
-
- // First try the field
+
+ // First try the field
Annotation[] fieldAnnotations = field.getAnnotations();
// and check with the profiles annotations
- BindingAnnotations bindingAnnotations = new BindingAnnotations(fieldAnnotations, new BindingAnnotations(annotations).getProfiles());
+ BindingAnnotations bindingAnnotations = new BindingAnnotations(fieldAnnotations,
+ new BindingAnnotations(annotations).getProfiles());
if (bindingAnnotations.checkNoBinding()) {
continue;
}
-
+
if (field.isAnnotationPresent(OneToOne.class) || field.isAnnotationPresent(ManyToOne.class)) {
isEntity = true;
relation = field.getType().getName();
@@ -130,9 +215,10 @@ public static T edit(String dbName, ParamNode rootParamNode,
if (_id == null || _id.equals("")) {
continue;
}
-
+
Query q = JPA.em(dbName).createQuery("from " + relation + " where " + keyName + " = ?1");
- q.setParameter(1, Binder.directBind(rootParamNode.getOriginalKey(), annotations,_id, Model.Manager.factoryFor((Class) Play.classloader.loadClass(relation)).keyType(), null));
+ q.setParameter(1, Binder.directBind(rootParamNode.getOriginalKey(), annotations, _id,
+ Model.Manager.factoryFor((Class) Play.classloader.loadClass(relation)).keyType(), null));
try {
l.add(q.getSingleResult());
@@ -147,21 +233,22 @@ public static T edit(String dbName, ParamNode rootParamNode,
if (ids != null && ids.length > 0 && !ids[0].equals("")) {
Query q = JPA.em(dbName).createQuery("from " + relation + " where " + keyName + " = ?1");
- q.setParameter(1, Binder.directBind(rootParamNode.getOriginalKey(), annotations, ids[0], Model.Manager.factoryFor((Class) Play.classloader.loadClass(relation)).keyType(), null));
+ q.setParameter(1, Binder.directBind(rootParamNode.getOriginalKey(), annotations, ids[0],
+ Model.Manager.factoryFor((Class) Play.classloader.loadClass(relation)).keyType(), null));
try {
Object to = q.getSingleResult();
edit(paramNode, field.getName(), to, field.getAnnotations());
// Remove it to prevent us from finding it again later
- paramNode.removeChild( field.getName(), removedNodesList);
+ paramNode.removeChild(field.getName(), removedNodesList);
bw.set(field.getName(), o, to);
} catch (NoResultException e) {
Validation.addError(fieldParamNode.getOriginalKey(), "validation.notFound", ids[0]);
// Remove only the key to prevent us from finding it again later
// This how the old impl does it..
fieldParamNode.removeChild(keyName, removedNodesList);
- if (fieldParamNode.getAllChildren().size()==0) {
+ if (fieldParamNode.getAllChildren().size() == 0) {
// remove the whole node..
- paramNode.removeChild( field.getName(), removedNodesList);
+ paramNode.removeChild(field.getName(), removedNodesList);
}
}
@@ -184,32 +271,68 @@ public static T edit(String dbName, ParamNode rootParamNode,
throw new UnexpectedException(e);
} finally {
// restoring changes to paramNode
- ParamNode.restoreRemovedChildren( removedNodesList );
+ ParamNode.restoreRemovedChildren(removedNodesList);
}
}
/**
- * This method is deprecated. Use this instead:
- *
- * public <T extends GenericModel> T edit(ParamNode rootParamNode, String name)
+ * Edit a model
+ *
+ * @param name
+ * name of the entity
+ * @param params
+ * list of parameters
+ * @param
+ * class of the entity
+ * @return the entity
+ *
+ * @deprecated use method {{@link #edit(ParamNode, String)}}
*/
@Deprecated
public T edit(String name, Map params) {
ParamNode rootParamNode = ParamNode.convert(params);
- return (T)edit(rootParamNode, name, this, null);
+ return (T) edit(rootParamNode, name, this, null);
}
+ /**
+ * Edit a model
+ *
+ * @param rootParamNode
+ * parameters used to create the new object
+ * @param name
+ * name of the entity
+ * @param
+ * class of the entity
+ * @return the entity
+ */
public T edit(ParamNode rootParamNode, String name) {
edit(rootParamNode, name, this, null);
return (T) this;
}
+ /**
+ * Edit a model
+ *
+ * @param dbName
+ * the db name
+ * @param rootParamNode
+ * parameters used to create the new object
+ * @param name
+ * name of the entity
+ * @param
+ * class of the entity
+ * @return the entity
+ */
public T edit(String dbName, ParamNode rootParamNode, String name) {
edit(dbName, rootParamNode, name, this, null);
return (T) this;
}
-
-
+
+ /**
+ * Validate and store the entity
+ *
+ * @return true if successful
+ */
public boolean validateAndSave() {
if (Validation.current().valid(this).ok) {
save();
@@ -218,6 +341,11 @@ public boolean validateAndSave() {
return false;
}
+ /**
+ * Validate and create the entity
+ *
+ * @return true if successful
+ */
public boolean validateAndCreate() {
if (Validation.current().valid(this).ok) {
return create();
@@ -227,6 +355,10 @@ public boolean validateAndCreate() {
/**
* store (ie insert) the entity.
+ *
+ * @param
+ * class of the entity
+ * @return true if successful
*/
public T save() {
_save();
@@ -235,6 +367,8 @@ public T save() {
/**
* store (ie insert) the entity.
+ *
+ * @return true if successful
*/
public boolean create() {
if (!em(JPA.getDBName(this.getClass())).contains(this)) {
@@ -246,6 +380,10 @@ public boolean create() {
/**
* Refresh the entity state.
+ *
+ * @param
+ * class of the entity
+ * @return The given entity
*/
public T refresh() {
em(JPA.getDBName(this.getClass())).refresh(this);
@@ -254,6 +392,10 @@ public T refresh() {
/**
* Merge this object to obtain a managed entity (useful when the object comes from the Cache).
+ *
+ * @param
+ * class of the entity
+ * @return The given entity
*/
public T merge() {
return (T) em(JPA.getDBName(this.getClass())).merge(this);
@@ -261,6 +403,9 @@ public T merge() {
/**
* Delete the entity.
+ *
+ * @param
+ * class of the entity
* @return The deleted entity.
*/
public T delete() {
@@ -268,12 +413,24 @@ public T delete() {
return (T) this;
}
+ /**
+ * Create the new entity
+ *
+ * @param name
+ * name of the model
+ * @param params
+ * list of parameters
+ * @param
+ * class of the entity
+ * @return The created entity.
+ */
public static T create(String name, Params params) {
throw new UnsupportedOperationException("Please annotate your JPA model with @javax.persistence.Entity annotation.");
}
/**
* Count entities
+ *
* @return number of entities of this class
*/
public static long count() {
@@ -281,10 +438,12 @@ public static long count() {
}
/**
- * Count entities with a special query.
- * Example : Long moderatedPosts = Post.count("moderated", true);
- * @param query HQL query or shortcut
- * @param params Params to bind to the query
+ * Count entities with a special query. Example : Long moderatedPosts = Post.count("moderated", true);
+ *
+ * @param query
+ * HQL query or shortcut
+ * @param params
+ * Params to bind to the query
* @return A long
*/
public static long count(String query, Object... params) {
@@ -293,6 +452,10 @@ public static long count(String query, Object... params) {
/**
* Find all entities of this type
+ *
+ * @param
+ * the type of the entity
+ * @return All entities of this type
*/
public static List findAll() {
throw new UnsupportedOperationException("Please annotate your JPA model with @javax.persistence.Entity annotation.");
@@ -300,7 +463,11 @@ public static List findAll() {
/**
* Find the entity with the corresponding id.
- * @param id The entity id
+ *
+ * @param id
+ * The entity id
+ * @param
+ * the type of the entity
* @return The entity
*/
public static T findById(Object id) {
@@ -309,8 +476,11 @@ public static T findById(Object id) {
/**
* Prepare a query to find entities.
- * @param query HQL query or shortcut
- * @param params Params to bind to the query
+ *
+ * @param query
+ * HQL query or shortcut
+ * @param params
+ * Params to bind to the query
* @return A JPAQuery
*/
public static JPAQuery find(String query, Object... params) {
@@ -319,6 +489,7 @@ public static JPAQuery find(String query, Object... params) {
/**
* Prepare a query to find *all* entities.
+ *
* @return A JPAQuery
*/
public static JPAQuery all() {
@@ -327,8 +498,11 @@ public static JPAQuery all() {
/**
* Batch delete of entities
- * @param query HQL query or shortcut
- * @param params Params to bind to the query
+ *
+ * @param query
+ * HQL query or shortcut
+ * @param params
+ * Params to bind to the query
* @return Number of entities deleted
*/
public static int delete(String query, Object... params) {
@@ -337,6 +511,7 @@ public static int delete(String query, Object... params) {
/**
* Delete all entities
+ *
* @return Number of entities deleted
*/
public static int deleteAll() {
@@ -374,9 +549,15 @@ public T first() {
}
/**
- * Bind a JPQL named parameter to the current query.
- * Careful, this will also bind count results. This means that Integer get transformed into long
- * so hibernate can do the right thing. Use the setParameter if you just want to set parameters.
+ * Bind a JPQL named parameter to the current query. Careful, this will also bind count results. This means that
+ * Integer get transformed into long so hibernate can do the right thing. Use the setParameter if you just want
+ * to set parameters.
+ *
+ * @param name
+ * name of the object
+ * @param param
+ * current query
+ * @return The query
*/
public JPAQuery bind(String name, Object param) {
if (param.getClass().isArray()) {
@@ -391,7 +572,13 @@ public JPAQuery bind(String name, Object param) {
/**
* Set a named parameter for this query.
- **/
+ *
+ * @param name
+ * Parameter name
+ * @param param
+ * The given parameters
+ * @return The query
+ */
public JPAQuery setParameter(String name, Object param) {
query.setParameter(name, param);
return this;
@@ -399,6 +586,9 @@ public JPAQuery setParameter(String name, Object param) {
/**
* Retrieve all results of the query
+ *
+ * @param
+ * the type of the entity
* @return A list of entities
*/
public List fetch() {
@@ -411,7 +601,11 @@ public List fetch() {
/**
* Retrieve results of the query
- * @param max Max results to fetch
+ *
+ * @param max
+ * Max results to fetch
+ * @param
+ * The entity class
* @return A list of entities
*/
public List fetch(int max) {
@@ -425,7 +619,11 @@ public List fetch(int max) {
/**
* Set the position to start
- * @param position Position of the first element
+ *
+ * @param position
+ * Position of the first element
+ * @param
+ * The entity class
* @return A new query
*/
public JPAQuery from(int position) {
@@ -435,8 +633,13 @@ public JPAQuery from(int position) {
/**
* Retrieve a page of result
- * @param page Page number (start at 1)
- * @param length (page length)
+ *
+ * @param page
+ * Page number (start at 1)
+ * @param length
+ * (page length)
+ * @param
+ * The entity class
* @return a list of entities
*/
public List fetch(int page, int length) {
diff --git a/framework/src/play/db/jpa/JPA.java b/framework/src/play/db/jpa/JPA.java
index 2f7dfabfd5..a1fd986b58 100644
--- a/framework/src/play/db/jpa/JPA.java
+++ b/framework/src/play/db/jpa/JPA.java
@@ -1,16 +1,21 @@
package play.db.jpa;
-import play.exceptions.JPAException;
-import play.Play;
-import play.Invoker.*;
-
-import java.util.concurrent.ConcurrentHashMap;
import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
-import javax.persistence.*;
+import javax.persistence.EntityManager;
+import javax.persistence.EntityManagerFactory;
+import javax.persistence.EntityTransaction;
+import javax.persistence.FlushModeType;
+import javax.persistence.PersistenceException;
+import javax.persistence.PersistenceUnit;
-import play.db.DB;
+import play.Invoker.InvocationContext;
+import play.Invoker.Suspend;
import play.Logger;
+import play.Play;
+import play.db.DB;
+import play.exceptions.JPAException;
import play.libs.F;
/**
@@ -18,11 +23,12 @@
*/
public class JPA {
- protected static Map emfs = new ConcurrentHashMap<>();
+ protected static Map emfs = new ConcurrentHashMap<>();
public static final ThreadLocal> currentEntityManager = new ThreadLocal>() {
- @Override protected Map initialValue() {
- return new ConcurrentHashMap<>();
- }
+ @Override
+ protected Map initialValue() {
+ return new ConcurrentHashMap<>();
+ }
};
public static String DEFAULT = "default";
@@ -33,7 +39,7 @@ public static class JPAContext {
public boolean autoCommit = false;
}
- public static boolean isInitialized(){
+ public static boolean isInitialized() {
return get(DEFAULT) != null;
}
@@ -46,6 +52,8 @@ static JPAContext get(String name) {
}
/**
+ * Clear a DB context
+ *
* @deprecated Use clearContext instead
* @since 1.3.0
* @see #clearContext(String)
@@ -54,10 +62,12 @@ static JPAContext get(String name) {
static void clearContext() {
get().clear();
}
-
+
/**
+ * Clear a DB context
*
- * @param name : the DB name
+ * @param name
+ * the DB name
*/
static void clearContext(String name) {
get().remove(name);
@@ -66,7 +76,7 @@ static void clearContext(String name) {
static void createContext(EntityManager entityManager, boolean readonly) {
createContext(JPA.DEFAULT, entityManager, readonly);
}
-
+
static void createContext(String dbName, EntityManager entityManager, boolean readonly) {
if (isInitialized()) {
try {
@@ -76,33 +86,46 @@ static void createContext(String dbName, EntityManager entityManager, boolean re
}
clearContext(dbName);
}
- bindForCurrentThread(dbName, entityManager, readonly);
+ bindForCurrentThread(dbName, entityManager, readonly);
}
public static EntityManager newEntityManager(String key) {
JPAPlugin jpaPlugin = Play.plugin(JPAPlugin.class);
- if(jpaPlugin == null) {
+ if (jpaPlugin == null) {
throw new JPAException("No JPA Plugin.");
}
EntityManager em = jpaPlugin.em(key);
- if(em == null) {
+ if (em == null) {
throw new JPAException("No JPA EntityManagerFactory configured for name [" + key + "]");
}
return em;
}
+
/**
* Get the EntityManager for specified persistence unit for this thread.
+ *
+ * @param key
+ * The DB name
+ *
+ * @return The EntityManager
*/
public static EntityManager em(String key) {
- JPAContext jpaContext = get(key);
- if (jpaContext == null)
- throw new JPAException("No active EntityManager for name [" + key + "], transaction not started?");
- return jpaContext.entityManager;
+ JPAContext jpaContext = get(key);
+ if (jpaContext == null)
+ throw new JPAException("No active EntityManager for name [" + key + "], transaction not started?");
+ return jpaContext.entityManager;
}
- /**
+ /**
* Bind an EntityManager to the current thread.
+ *
+ * @param name
+ * The DB name
+ * @param em
+ * The EntityManager
+ * @param readonly
+ * indicate if it is in read only mode
*/
public static void bindForCurrentThread(String name, EntityManager em, boolean readonly) {
JPAContext context = new JPAContext();
@@ -131,11 +154,11 @@ public static EntityManager em() {
* Tell to JPA do not commit the current transaction
*/
public static void setRollbackOnly() {
- setRollbackOnly(DEFAULT);
+ setRollbackOnly(DEFAULT);
}
public static void setRollbackOnly(String em) {
- get(em).entityManager.getTransaction().setRollbackOnly();
+ get(em).entityManager.getTransaction().setRollbackOnly();
}
/**
@@ -151,6 +174,10 @@ public static boolean isEnabled(String em) {
/**
* Execute a JPQL query
+ *
+ * @param query
+ * The query to execute
+ * @return The result code
*/
public static int execute(String query) {
return execute(DEFAULT, query);
@@ -160,16 +187,15 @@ public static int execute(String em, String query) {
return em(em).createQuery(query).executeUpdate();
}
-
- // * Build a new entityManager.
- // * (In most case you want to use the local entityManager with em)
-
+ // * Build a new entityManager.
+ // * (In most case you want to use the local entityManager with em)
+
public static EntityManager newEntityManager() {
return createEntityManager();
}
public static EntityManager createEntityManager() {
- return createEntityManager(JPA.DEFAULT);
+ return createEntityManager(JPA.DEFAULT);
}
public static EntityManager createEntityManager(String name) {
@@ -192,9 +218,9 @@ public static boolean isInsideTransaction(String name) {
}
public static T withinFilter(F.Function0 block) throws Throwable {
- if(InvocationContext.current().getAnnotation(NoTransaction.class) != null ) {
- //Called method or class is annotated with @NoTransaction telling us that
- //we should not start a transaction
+ if (InvocationContext.current().getAnnotation(NoTransaction.class) != null) {
+ // Called method or class is annotated with @NoTransaction telling us that
+ // we should not start a transaction
return block.apply();
}
@@ -212,11 +238,10 @@ public static T withinFilter(F.Function0 block) throws Throwable {
return withTransaction(name, readOnly, block);
}
-
public static String getDBName(Class clazz) {
String name = JPA.DEFAULT;
- if(clazz != null){
- PersistenceUnit pu = (PersistenceUnit)clazz.getAnnotation(PersistenceUnit.class);
+ if (clazz != null) {
+ PersistenceUnit pu = clazz.getAnnotation(PersistenceUnit.class);
if (pu != null) {
name = pu.name();
}
@@ -224,19 +249,26 @@ public static String getDBName(Class clazz) {
return name;
}
-
/**
* Run a block of code in a JPA transaction.
*
- * @param dbName The persistence unit name
- * @param readOnly Is the transaction read-only?
- * @param block Block of code to execute.
+ * @param dbName
+ * The persistence unit name
+ * @param readOnly
+ * Is the transaction read-only?
+ * @param block
+ * Block of code to execute.
+ * @param
+ * The entity class
+ * @return The result
+ * @throws java.lang.Throwable
+ * Thrown in case of error
*/
public static T withTransaction(String dbName, boolean readOnly, F.Function0 block) throws Throwable {
if (isEnabled()) {
boolean closeEm = true;
// For each existing persistence unit
-
+
try {
// we are starting a transaction for all known persistent unit
// this is probably not the best, but there is no way we can know where to go from
@@ -251,14 +283,15 @@ public static T withTransaction(String dbName, boolean readOnly, F.Function0
}
T result = block.apply();
-
+
boolean rollbackAll = false;
// Get back our entity managers
// Because people might have mess up with the current entity managers
for (JPAContext jpaContext : get().values()) {
EntityManager m = jpaContext.entityManager;
EntityTransaction localTx = m.getTransaction();
- // The resource transaction must be in progress in order to determine if it has been marked for rollback
+ // The resource transaction must be in progress in order to determine if it has been marked for
+ // rollback
if (localTx.isActive() && localTx.getRollbackOnly()) {
rollbackAll = true;
}
@@ -283,7 +316,7 @@ public static T withTransaction(String dbName, boolean readOnly, F.Function0
// Nothing, transaction is in progress
closeEm = false;
throw e;
- } catch(Throwable t) {
+ } catch (Throwable t) {
// Because people might have mess up with the current entity managers
for (JPAContext jpaContext : get().values()) {
EntityManager m = jpaContext.entityManager;
@@ -293,7 +326,7 @@ public static T withTransaction(String dbName, boolean readOnly, F.Function0
if (localTx.isActive()) {
localTx.rollback();
}
- } catch(Throwable e) {
+ } catch (Throwable e) {
}
}
@@ -310,18 +343,20 @@ public static T withTransaction(String dbName, boolean readOnly, F.Function0
for (String name : emfs.keySet()) {
JPA.unbindForCurrentThread(name);
}
- }
- }
+ }
+ }
} else {
return block.apply();
}
}
- /**
+ /**
* initialize the JPA context and starts a JPA transaction
*
- * @param name The persistence unit name
- * @param readOnly true for a readonly transaction
+ * @param name
+ * The persistence unit name
+ * @param readOnly
+ * true for a readonly transaction
*/
public static void startTx(String name, boolean readOnly) {
EntityManager manager = createEntityManager(name);
@@ -333,15 +368,16 @@ public static void startTx(String name, boolean readOnly) {
public static void closeTx(String name) {
if (JPA.isInsideTransaction(name)) {
- EntityManager manager = em(name);
- try {
- // Be sure to set the connection is non-autoCommit mode as some driver will complain about COMMIT statement
+ EntityManager manager = em(name);
+ try {
+ // Be sure to set the connection is non-autoCommit mode as some driver will complain about COMMIT
+ // statement
try {
DB.getConnection(name).setAutoCommit(false);
- } catch(Exception e) {
+ } catch (Exception e) {
Logger.error(e, "Why the driver complains here?");
}
- // Commit the transaction
+ // Commit the transaction
if (manager.getTransaction().isActive()) {
if (JPA.get().get(name).readonly || manager.getTransaction().getRollbackOnly()) {
manager.getTransaction().rollback();
@@ -374,19 +410,20 @@ public static void closeTx(String name) {
public static void rollbackTx(String name) {
if (JPA.isInsideTransaction()) {
- EntityManager manager = em(name);
- try {
- // Be sure to set the connection is non-autoCommit mode as some driver will complain about COMMIT statement
+ EntityManager manager = em(name);
+ try {
+ // Be sure to set the connection is non-autoCommit mode as some driver will complain about COMMIT
+ // statement
try {
DB.getConnection(name).setAutoCommit(false);
- } catch(Exception e) {
+ } catch (Exception e) {
Logger.error(e, "Why the driver complains here?");
}
- // Commit the transaction
+ // Commit the transaction
if (manager.getTransaction().isActive()) {
try {
- manager.getTransaction().rollback();
- } catch (Throwable e) {
+ manager.getTransaction().rollback();
+ } catch (Throwable e) {
for (int i = 0; i < 10; i++) {
if (e instanceof PersistenceException && e.getCause() != null) {
e = e.getCause();
@@ -400,7 +437,7 @@ public static void rollbackTx(String name) {
throw new JPAException("Cannot commit", e);
}
}
-
+
} finally {
if (manager.isOpen()) {
manager.close();
diff --git a/framework/src/play/db/jpa/JPABase.java b/framework/src/play/db/jpa/JPABase.java
index 8024f5a03b..3b30a0217d 100644
--- a/framework/src/play/db/jpa/JPABase.java
+++ b/framework/src/play/db/jpa/JPABase.java
@@ -1,8 +1,29 @@
package play.db.jpa;
-import org.hibernate.collection.spi.PersistentCollection;
+import java.io.Serializable;
+import java.lang.reflect.Field;
+import java.lang.reflect.Modifier;
+import java.sql.SQLException;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+import javax.persistence.CascadeType;
+import javax.persistence.EntityManager;
+import javax.persistence.ManyToMany;
+import javax.persistence.ManyToOne;
+import javax.persistence.MappedSuperclass;
+import javax.persistence.OneToMany;
+import javax.persistence.OneToOne;
+import javax.persistence.PersistenceException;
+
import org.hibernate.collection.internal.PersistentMap;
-import org.hibernate.engine.spi.*;
+import org.hibernate.collection.spi.PersistentCollection;
+import org.hibernate.engine.spi.CollectionEntry;
+import org.hibernate.engine.spi.EntityEntry;
import org.hibernate.engine.spi.PersistenceContext;
import org.hibernate.exception.GenericJDBCException;
import org.hibernate.internal.SessionImpl;
@@ -14,14 +35,6 @@
import play.PlayPlugin;
import play.exceptions.UnexpectedException;
-import javax.persistence.*;
-
-import java.io.Serializable;
-import java.lang.reflect.Field;
-import java.lang.reflect.Modifier;
-import java.sql.SQLException;
-import java.util.*;
-
/**
* A super class for JPA entities
*/
@@ -61,7 +74,7 @@ public void _save() {
@Override
public void _delete() {
String dbName = JPA.getDBName(this.getClass());
-
+
try {
avoidCascadeSaveLoops.set(new HashSet());
try {
@@ -188,7 +201,7 @@ private void saveAndCascade(boolean willBeSaved) {
private void cascadeOrphans(JPABase base, PersistentCollection persistentCollection, boolean willBeSaved) {
String dbName = JPA.getDBName(this.getClass());
-
+
SessionImpl session = ((SessionImpl) JPA.em(dbName).getDelegate());
PersistenceContext pc = session.getPersistenceContext();
CollectionEntry ce = pc.getCollectionEntry(persistentCollection);
@@ -199,7 +212,7 @@ private void cascadeOrphans(JPABase base, PersistentCollection persistentCollect
Type ct = cp.getElementType();
if (ct instanceof EntityType) {
EntityEntry entry = pc.getEntry(base);
- String entityName = entry.getEntityName();
+ String entityName = entry.getEntityName();
entityName = ((EntityType) ct).getAssociatedEntityName(session.getFactory());
if (ce.getSnapshot() != null) {
Collection orphans = ce.getOrphans(entityName, persistentCollection);
@@ -229,6 +242,9 @@ private static boolean cascadeAll(CascadeType[] types) {
/**
* Retrieve the current entityManager
+ *
+ * @param name
+ * The DB name
*
* @return the current entityManager
*/
@@ -236,7 +252,7 @@ public static EntityManager em(String name) {
return JPA.em(name);
}
- public static EntityManager em() {
+ public static EntityManager em() {
return JPA.em();
}
@@ -249,9 +265,11 @@ public boolean isPersistent() {
}
/**
- * JPASupport instances a and b are equals if either a == b or a and b have same {@link #_key key} and class
+ * JPASupport instances a and b are equals if either a == b or a and b have same
+ * {@link #_key key} and class
*
* @param other
+ * The object to compare to
* @return true if equality condition above is verified
*/
@Override
@@ -275,7 +293,6 @@ public boolean equals(Object other) {
return false;
}
-
if (!this.getClass().isAssignableFrom(other.getClass())) {
return false;
}
diff --git a/framework/src/play/db/jpa/NoTransaction.java b/framework/src/play/db/jpa/NoTransaction.java
index 544e02e0e7..29f7027bc8 100644
--- a/framework/src/play/db/jpa/NoTransaction.java
+++ b/framework/src/play/db/jpa/NoTransaction.java
@@ -1,6 +1,5 @@
package play.db.jpa;
-
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
@@ -8,16 +7,16 @@
import java.lang.annotation.Target;
/**
- * Annotation to be used on methods telling JPA
- * that it should not create a Transaction at all
+ * Annotation to be used on methods telling JPA that it should not create a Transaction at all
*/
@Retention(RetentionPolicy.RUNTIME)
@Inherited
-@Target(value = {ElementType.METHOD, ElementType.TYPE})
+@Target(value = { ElementType.METHOD, ElementType.TYPE })
public @interface NoTransaction {
/**
* Db name we do not want transaction.
+ *
+ * @return The DB name
*/
String value() default "default";
}
-
diff --git a/framework/src/play/db/jpa/Transactional.java b/framework/src/play/db/jpa/Transactional.java
index 588254fcef..f940197684 100644
--- a/framework/src/play/db/jpa/Transactional.java
+++ b/framework/src/play/db/jpa/Transactional.java
@@ -6,13 +6,14 @@
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ ElementType.METHOD, ElementType.TYPE })
public @interface Transactional {
/**
* Db name where to persist for multi db support
+ *
+ * @return The DB name
*/
String value() default "default";
public boolean readOnly() default false;
}
-
diff --git a/framework/src/play/inject/Injector.java b/framework/src/play/inject/Injector.java
index ec290e2156..a9e34dfc1a 100644
--- a/framework/src/play/inject/Injector.java
+++ b/framework/src/play/inject/Injector.java
@@ -4,16 +4,21 @@
import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.List;
+
import javax.inject.Inject;
+
import play.Play;
import play.classloading.enhancers.ControllersEnhancer.ControllerSupport;
import play.jobs.Job;
import play.mvc.Mailer;
public class Injector {
-
+
/**
* For now, inject beans in controllers
+ *
+ * @param source
+ * the beanSource to inject
*/
public static void inject(BeanSource source) {
List classes = new ArrayList<>(Play.classloader.getAssignableClasses(ControllerSupport.class));
@@ -26,9 +31,9 @@ public static void inject(BeanSource source) {
field.setAccessible(true);
try {
field.set(null, source.getBeanOfType(type));
- } catch(RuntimeException e) {
+ } catch (RuntimeException e) {
throw e;
- } catch(Exception e) {
+ } catch (Exception e) {
throw new RuntimeException(e);
}
}
diff --git a/framework/src/play/jobs/Job.java b/framework/src/play/jobs/Job.java
index 4bf7f220e3..901ce062b8 100644
--- a/framework/src/play/jobs/Job.java
+++ b/framework/src/play/jobs/Job.java
@@ -5,10 +5,15 @@
import java.util.concurrent.ExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
+
+import com.jamonapi.Monitor;
+import com.jamonapi.MonitorFactory;
+
import play.Invoker;
import play.Invoker.InvocationContext;
import play.Logger;
import play.Play;
+import play.PlayPlugin;
import play.exceptions.JavaExecutionException;
import play.exceptions.PlayException;
import play.exceptions.UnexpectedException;
@@ -16,14 +21,12 @@
import play.libs.F.Promise;
import play.libs.Time;
import play.mvc.Http;
-import play.PlayPlugin;
-
-import com.jamonapi.Monitor;
-import com.jamonapi.MonitorFactory;
/**
* A job is an asynchronously executed unit of work
- * @param The job result type (if any)
+ *
+ * @param
+ * The job result type (if any)
*/
public class Job extends Invoker.Invocation implements Callable {
@@ -43,12 +46,19 @@ public InvocationContext getInvocationContext() {
/**
* Here you do the job
+ *
+ * @throws Exception
+ * if problems occurred
*/
public void doJob() throws Exception {
}
/**
* Here you do the job and return a result
+ *
+ * @return The job result
+ * @throws Exception
+ * if problems occurred
*/
public V doJobWithResult() throws Exception {
doJob();
@@ -57,11 +67,12 @@ public V doJobWithResult() throws Exception {
@Override
public void execute() throws Exception {
-
+
}
/**
* Start this job now (well ASAP)
+ *
* @return the job completion
*/
public Promise now() {
@@ -70,31 +81,33 @@ public Promise now() {
return smartFuture;
}
- /**
- * If is called in a 'HttpRequest' invocation context, waits until request
- * is served and schedules job then.
- *
- * Otherwise is the same as now();
- *
- * If you want to schedule a job to run after some other job completes, wait till a promise redeems
- * of just override first Job's call() to schedule the second one.
- *
- * @return the job completion
- */
- public Promise afterRequest() {
- InvocationContext current = Invoker.InvocationContext.current();
- if(current == null || !Http.invocationType.equals(current.getInvocationType())) {
- return now();
- }
+ /**
+ * If is called in a 'HttpRequest' invocation context, waits until request is served and schedules job then.
+ *
+ * Otherwise is the same as now();
+ *
+ * If you want to schedule a job to run after some other job completes, wait till a promise redeems of just override
+ * first Job's call() to schedule the second one.
+ *
+ * @return the job completion
+ */
+ public Promise afterRequest() {
+ InvocationContext current = Invoker.InvocationContext.current();
+ if (current == null || !Http.invocationType.equals(current.getInvocationType())) {
+ return now();
+ }
- Promise smartFuture = new Promise<>();
- Callable callable = getJobCallingCallable(smartFuture);
- JobsPlugin.addAfterRequestAction(callable);
- return smartFuture;
- }
+ Promise smartFuture = new Promise<>();
+ Callable callable = getJobCallingCallable(smartFuture);
+ JobsPlugin.addAfterRequestAction(callable);
+ return smartFuture;
+ }
/**
* Start this job in several seconds
+ *
+ * @param delay
+ * time in seconds
* @return the job completion
*/
public Promise in(String delay) {
@@ -103,6 +116,9 @@ public Promise in(String delay) {
/**
* Start this job in several seconds
+ *
+ * @param seconds
+ * time in seconds
* @return the job completion
*/
public Promise in(int seconds) {
@@ -112,28 +128,30 @@ public Promise in(int seconds) {
}
private Callable getJobCallingCallable(final Promise smartFuture) {
- return new Callable() {
- @Override
- public V call() throws Exception {
- try {
- V result = Job.this.call();
- if (smartFuture != null) {
- smartFuture.invoke(result);
+ return new Callable() {
+ @Override
+ public V call() throws Exception {
+ try {
+ V result = Job.this.call();
+ if (smartFuture != null) {
+ smartFuture.invoke(result);
+ }
+ return result;
+ } catch (Exception e) {
+ if (smartFuture != null) {
+ smartFuture.invokeWithException(e);
+ }
+ return null;
+ }
}
- return result;
- }
- catch (Exception e) {
- if (smartFuture != null) {
- smartFuture.invokeWithException(e);
- }
- return null;
- }
- }
- };
+ };
}
/**
* Run this job every n seconds
+ *
+ * @param delay
+ * time in seconds
*/
public void every(String delay) {
every(Time.parseDuration(delay));
@@ -141,6 +159,9 @@ public void every(String delay) {
/**
* Run this job every n seconds
+ *
+ * @param seconds
+ * time in seconds
*/
public void every(int seconds) {
JobsPlugin.executor.scheduleWithFixedDelay(this, seconds, seconds, TimeUnit.SECONDS);
@@ -154,17 +175,17 @@ public void onException(Throwable e) {
lastException = e;
try {
super.onException(e);
- } catch(Throwable ex) {
+ } catch (Throwable ex) {
Logger.error(ex, "Error during job execution (%s)", this);
throw new UnexpectedException(unwrap(e));
}
}
private Throwable unwrap(Throwable e) {
- while((e instanceof UnexpectedException || e instanceof PlayException) && e.getCause() != null) {
- e = e.getCause();
- }
- return e;
+ while ((e instanceof UnexpectedException || e instanceof PlayException) && e.getCause() != null) {
+ e = e.getCause();
+ }
+ return e;
}
@Override
@@ -172,19 +193,14 @@ public void run() {
call();
}
-
-
-
-
-
- private V withinFilter(play.libs.F.Function0 fct) throws Throwable {
- F.Option> filters = Play.pluginCollection.composeFilters();
- if (!filters.isDefined()) {
- return null;
- } else {
- return filters.get().withinFilter(fct);
+ private V withinFilter(play.libs.F.Function0 fct) throws Throwable {
+ F.Option