Recent changes to Open Infinity Core - documentation

WikiPage Open Infinity Core - documentation modified by Ilkka Leinonen

Ilkka Leinonen — Wed, 02 May 2012 17:51:54 -0000

--- v23 
+++ v24 
@@ -16,12 +16,12 @@
 =================================
 The package includes the following functionality.
 
-Audittrail
+AuditTrail
 -----------
 This annotation represents the metadata added to the runtime method. The metadata executes the org.openinfinity.core.aspect.AuditTrailAspect -aspect when defined. Annotation can be defined in the method level.
 
 ~~~~~~
-@Auditrail
+@AudiTrail
 public SomeObject someMethod(AnotherObject anotherObject() {...}
 
 @AuditTrail(

WikiPage Open Infinity Core - documentation modified by Ilkka Leinonen

Ilkka Leinonen — Thu, 12 Apr 2012 09:59:21 -0000

--- v22 
+++ v23 
@@ -25,7 +25,12 @@
 public SomeObject someMethod(AnotherObject anotherObject() {...}
 
 @AuditTrail(
-isUsernameEnabled=true,isRolesEnabled=false,isTimeStampEnabled=true, value={"auto/tire/screw","personId"}, argumentStrategy=CUSTOM)
+    isUsernameEnabled=true,
+    isRolesEnabled=false,
+    isTimeStampEnabled=true, 
+    value={"auto/tire/screw","personId"}, 
+    argumentStrategy=CUSTOM
+)
 public SomeObject someMethod(AnotherObject anotherObject() {...}
 ~~~~~~

WikiPage Open Infinity Core - documentation modified by Ilkka Leinonen

Ilkka Leinonen — Tue, 10 Apr 2012 17:41:43 -0000

--- v21 
+++ v22 
@@ -1,4 +1,4 @@
-Open Infinity Core - 1.0.X
+Open Infinity Core - 1.0.X.RELEASE
 ==================
 
 Open Infinity Core framework is a solution accelerator providing best practices patterns and tactics to overcome cross-cutting concerns like audit trail, logging, standardized and localized exception hierarchy, validation, security and quality.

WikiPage Open Infinity Core - documentation modified by Ilkka Leinonen

Ilkka Leinonen — Tue, 10 Apr 2012 17:40:59 -0000

--- v20 
+++ v21 
@@ -1,4 +1,4 @@
-Open Infinity Core
+Open Infinity Core - 1.0.X
 ==================
 
 Open Infinity Core framework is a solution accelerator providing best practices patterns and tactics to overcome cross-cutting concerns like audit trail, logging, standardized and localized exception hierarchy, validation, security and quality.

WikiPage Open Infinity Core - documentation modified by Ilkka Leinonen

Ilkka Leinonen — Mon, 09 Apr 2012 20:13:51 -0000

--- v19 
+++ v20 
@@ -245,3 +245,24 @@
     StringUtil.toString(this);
 }
 ~~~~~~
+
+
+JdbcPropertyPlaceholderConfigurer
+-----------
+Utility for key-value properties from JDBC datasource.
+
+~~~~~~
+
+
+
+    
+    
+        
+            
+               classpath:/META-INF/properties/logging.properties
+            
+        
+    
+    
+
+~~~~~~

WikiPage Open Infinity Core - documentation modified by Ilkka Leinonen

Ilkka Leinonen — Mon, 09 Apr 2012 20:01:02 -0000

--- v18 
+++ v19 
@@ -1,7 +1,7 @@
 Open Infinity Core
 ==================
 
-Open Infinity Core framework is a solution accelerator providing best practices patterns and tactics to overcome cross-cutting concerns like audit trail, logging, standardized and localized exception hierarchy, validation, security etc. 
+Open Infinity Core framework is a solution accelerator providing best practices patterns and tactics to overcome cross-cutting concerns like audit trail, logging, standardized and localized exception hierarchy, validation, security and quality. 
 
 Package | Explanation
 --------| -----------

WikiPage Open Infinity Core - documentation modified by Ilkka Leinonen

Ilkka Leinonen — Mon, 09 Apr 2012 19:59:45 -0000

--- v17 
+++ v18 
@@ -1,7 +1,7 @@
 Open Infinity Core
 ==================
 
-Open Infinity Core framework is a solution accelerator providing best practices patterns and tactics to overcome boiler plate coding like audit trail, logging, security etc. 
+Open Infinity Core framework is a solution accelerator providing best practices patterns and tactics to overcome cross-cutting concerns like audit trail, logging, standardized and localized exception hierarchy, validation, security etc. 
 
 Package | Explanation
 --------| -----------

WikiPage Open Infinity Core - documentation modified by Ilkka Leinonen

Ilkka Leinonen — Mon, 09 Apr 2012 19:57:35 -0000

--- v16 
+++ v17 
@@ -71,36 +71,42 @@
       
-~~~~~~
-
+
+~~~~~~
+
 ExceptionTranslationAspect
 -----------
 Aspect for handling controller and service level exception translation. Service level exceptions should always be instance of org.openinfinity.core.exception.ApplicationException,org.openinfinity.core.exception.SystemException or org.openinfinity.core.exception.BusinessViolationException. Unknown exceptions will be translated to org.openinfinity.core.exception.SystemException.
 
 ~~~~~~
  
 
 
       
 
 
- 
 
 
       
 
 
-
+
 ~~~~~~
 
 org.openinfinity.core.exception

WikiPage Open Infinity Core - documentation modified by Ilkka Leinonen

Ilkka Leinonen — Mon, 09 Apr 2012 19:55:45 -0000

--- v15 
+++ v16 
@@ -29,128 +29,134 @@
 public SomeObject someMethod(AnotherObject anotherObject() {...}
 ~~~~~~
 
+
 Log
 -----------
 This annotation represents the metadata added to the runtime method. The metadata executes the org.openinfinity.core.aspect.LogAspect-aspect when defined. Annotation can be defined in the method level.
 
 ~~~~~~
 @Log
 public SomeObject someMethod(AnotherObject anotherObject() {...}
 
 @Log(level=LogLevel.INFO)
 public SomeObject someMethod(AnotherObject anotherObject() {...}
 ~~~~~~
 
+
 NotScript
 -----------
 Field validator for validating XSS attacks. 
 
 ~~~~~~
 @NotScript
 private String someField;
 
 @NotScript(allowedInputPattern=Person.SSN_XSS)
 private String someField;
 ~~~~~~
 
 org.openinfinity.core.aspect
 =================================
 The package includes the following functionality.
 
+
 AuditTrailAspect
 -----------
 Class is responsible for creating audit trail information. Audit trail storage system can be defined through Log4j property files (JDBCAppender, FileAppender, JMSAppender etc).
 
 ~~~~~~
  
 
 
       
 ~~~~~~
 
 ExceptionTranslationAspect
 -----------
 Aspect for handling controller and service level exception translation. Service level exceptions should always be instance of org.openinfinity.core.exception.ApplicationException,org.openinfinity.core.exception.SystemException or org.openinfinity.core.exception.BusinessViolationException. Unknown exceptions will be translated to org.openinfinity.core.exception.SystemException.
 
 ~~~~~~
  
 
 
       
 
 
  
 
 
       
 
 
 
 ~~~~~~
 
 org.openinfinity.core.exception
 =================================
 The package includes the following functionality.
 
+
 BusinessViolationException
 -----------
 Business violation exception is thrown when business rule fails. This kind of behaviour has a fatal impact for the business. Exception is derived from org.openinfinity.core.exception.AbstractCoreException.
 
 Service interface mapped to error properties:
 
 ~~~~~~
 private static final UNIQUE_EXCEPTION = ”bve.exception.not.found”;
 ~~~~~~
 
 Service implementation using localized properties:
 
 ~~~~~~
 if (product.isNotFound()) {
     BusinessViolationException bve = new BusinessViolationException
     (
         ”Product not found”,      
         ExceptionLevel.ERROR,
         UNIQUE_EXCEPTION
     ); 
     throw bve;
 } 
 ~~~~~~
 
 or simply using core utilities:
 
 ~~~~~~
 if (product.isNotFound()) { 
     ExceptionUtil.throwBusinessViolationException(
         ”Product not found”, 
         ExceptionLevel.ERROR, 
     UNIQUE_EXCEPTION);
 }
 ~~~~~~
 
+
 SystemException
 -----------
 This class holds information about the system errors.This exception will be thrown when system level exception occurs (connection failure etc). Exception is derived from org.openinfinity.core.exception.AbstractCoreException.
 
 ~~~~~~
 private static final UNIQUE_EXCEPTION = ”se.exception.cf”;
 if (connection.isInFailureState()) {
    SystemException se = new SystemException
    (
        ”Connection failure occurred”,
        ExceptionLevel.WARNING,
        UNIQUE_EXCEPTION
    ); 
    throw se;
 }
 ~~~~~~
@@ -159,64 +165,69 @@
 
 ~~~~~~
 if (product.isNotFound()) { 
        ExceptionUtil.throwSystemException
        (
            ”Connection failure occurred”,
             ExceptionLevel.WARNING,
             UNIQUE_EXCEPTION
        );
 }
 ~~~~~~
 
+
 ApplicationException
 -----------
 This class holds information about application error. This exception should be thrown when application (use cases) specific problems occurs. 
 Exception is derived from org.openinfinity.core.exception.AbstractCoreException.
 
 ~~~~~~
 if (product.ifContainsIllegalInformation()) {    
    ExceptionUtil.throwApplicationException
    (
       ”Product contains illegal information”,   
       ExceptionLevel.INFORMATIVE, 
       UNIQUE_EXCEPTION
    );
 }
 ~~~~~~
 
+
 AspectUtil
 -----------
 Utility for handling aspect specific features.
 
 ~~~~~~
 Log logAnnotation = AspectUtil.getAnnotation(joinPoint, Log.class);
 ~~~~~~
 
+
 ExceptionUtil
 -----------
 Exception utility class which offers basic methods for exception throwing and stack trace resolving.
 
 ~~~~~~
 String stackTrace = ExceptionUtil.getStackTraceString(throwable);
 ~~~~~~
 
 or:
 
 ~~~~~~
 ExceptionUtil.throwBusinessViolationException(cause);
 ~~~~~~
 
+
 IOUtil
 -----------
 Utility for handling stream, reader and writer objects.
 
 ~~~~~~
 IOUtil.copyStream(inputStream, outputStream);
 IOUtil.getBytes(object);
 IOUtil.closeReader(reader);
 IOUtil.closeWriter(writer);
 IOUtil.closeStream(stream);
 ~~~~~~
+
 
 StringUtil
 -----------

WikiPage Open Infinity Core - documentation modified by Ilkka Leinonen

Ilkka Leinonen — Mon, 09 Apr 2012 19:54:17 -0000

--- v14 
+++ v15 
@@ -205,3 +205,26 @@
 ~~~~~~
 ExceptionUtil.throwBusinessViolationException(cause);
 ~~~~~~
+
+IOUtil
+-----------
+Utility for handling stream, reader and writer objects.
+
+~~~~~~
+IOUtil.copyStream(inputStream, outputStream);
+IOUtil.getBytes(object);
+IOUtil.closeReader(reader);
+IOUtil.closeWriter(writer);
+IOUtil.closeStream(stream);
+~~~~~~
+
+StringUtil
+-----------
+Helper class for handling Strings.
+
+~~~~~~
+@Override
+Public String toString() {
+    StringUtil.toString(this);
+}
+~~~~~~