diff --git a/template-project/war/WEB-INF/lib/gaelyk-0.4.1.jar b/template-project/war/WEB-INF/lib/gaelyk-0.4.1.jar index 3568493e..91ab831f 100644 Binary files a/template-project/war/WEB-INF/lib/gaelyk-0.4.1.jar and b/template-project/war/WEB-INF/lib/gaelyk-0.4.1.jar differ diff --git a/website/war/api/allclasses-frame.html b/website/war/api/allclasses-frame.html index b0d9c0e2..3f910f54 100644 --- a/website/war/api/allclasses-frame.html +++ b/website/war/api/allclasses-frame.html @@ -21,6 +21,12 @@
java.lang.Object groovyx.gaelyk.GaelykBindingEnhancer
public class GaelykBindingEnhancer +class GaelykBindingEnhancer- Class responsible for adding adding Google App Engine related services into the binding of Groovlets and Templates.
public static void bind(Binding binding)+
static void bind(Binding binding)
binding
- Binding in which to bind the GAE services and variables
java.lang.Object groovyx.gaelyk.GaelykCategory
public class GaelykCategory +class GaelykCategoryCategory methods decorating the Google App Engine SDK classes adding new shortcut methods to simplify the usage of the SDK - from within Groovy servlets and templates.
static Object
+ static void
set(Entity entity, String name, Object value)
@@ -521,7 +521,7 @@ static Object
+ static void
setAt(Entity entity, String name, Object value)
@@ -531,6 +531,42 @@ static Object
+ withReader(BlobKey selfKey, String encoding, Closure c)
+ Creates a (buffered) Reader
over the blob with a specified encoding.
+
static Object
+ withReader(BlobKey selfKey, Closure c)
+ Creates a (buffered) Reader
over the blob using UTF-8 as default encoding.
+
static Object
+ withStream(BlobKey selfKey, Closure c)
+ Creates an InputStream
over the blob.
+
static Transaction
@@ -549,7 +585,7 @@ public static TaskHandle add(Queue selfQueue, Map params)+
static TaskHandle add(Queue selfQueue, Map params)
@@ -606,8 +642,8 @@
payload
taskName
url
params
- the map of task attributes
public static Object asType(String self, Class clazz)+
static Object asType(String self, Class clazz)
@@ -637,7 +673,7 @@
asType
- public static Link asType(URL self, Class linkClass)
+ static Link asType(URL self, Class linkClass)
- Converter method for converting a URL into a Link instance
@@ -651,7 +687,7 @@
asType
- public static Object asType(Integer self, Class ratingClass)
+ static Object asType(Integer self, Class ratingClass)
- Converter method for converting an integer into a Rating instance
@@ -665,7 +701,7 @@
asType
- public static Object asType(byte[] self, Class blobClass)
+ static Object asType(byte[] self, Class blobClass)
- Converter method for converting a byte array into a Blob or ShortBlob instance
@@ -680,7 +716,7 @@
asType
- public static Object asType(List floatPair, Class geoptClass)
+ static Object asType(List floatPair, Class geoptClass)
- Converter method for converting a pair of numbers (in a list) into a GeoPt instance
@@ -694,7 +730,7 @@
delete
- public static Object delete(Entity entity)
+ static Object delete(Entity entity)
- Delete this entity from the data store.
Usage:
entity.delete()
@@ -706,7 +742,7 @@
get
- public static Object get(Entity entity, String name)
+ static Object get(Entity entity, String name)
- Provides a shortcut notation to get a property of an entity.
Instead of writing
@@ -721,7 +757,7 @@
getAt
- public static Object getAt(Entity entity, String name)
+ static Object getAt(Entity entity, String name)
- Provides a shortcut notation to get a property of an entity.
Instead of writing
@@ -736,11 +772,11 @@
getAt
- public static Object getAt(MemcacheService memcache, Object key)
+ static Object getAt(MemcacheService memcache, Object key)
- Get an object from the cache, identified by its key, using the subscript notation:
-
def obj = memcache[key]
- param:
- key the key identifying the object to get from the cache
-
+ def obj = memcache[key]
+ - Parameters:
key
- the key identifying the object to get from the cache
@@ -748,11 +784,11 @@
getAt
- public static Object getAt(MemcacheService memcache, String key)
+ static Object getAt(MemcacheService memcache, String key)
- Get an object from the cache, identified by its key, using the subscript notation:
-
def obj = memcache[key]
- param:
- key the key identifying the object to get from the cache
-
+ def obj = memcache[key]
+ - Parameters:
key
- the key identifying the object to get from the cache
@@ -760,10 +796,10 @@
getFrom
- public static String getFrom(def message)
+ static String getFrom(def message)
- - Get the sender Jabber ID of the message in the form of a String.
- return:
- the Jabber ID of the sender
-
+ - Get the sender Jabber ID of the message in the form of a String.
+
- Returns:
- the Jabber ID of the sender
@@ -771,13 +807,13 @@
getName
- public static String getName(Queue selfQueue)
+ static String getName(Queue selfQueue)
- Shorcut to get the name of the Queue.
Instead of having to call queue.getQueueName()
or queue.queueName
,
- you can use the syntax queue.name
which is more concise.
- return:
- the name of the queue
-
+ you can use the syntax queue.name
which is more concise.
+ - Returns:
- the name of the queue
@@ -785,10 +821,10 @@
getPresence
- public static Presence getPresence(XMPPService xmppService, String jabberId)
+ static Presence getPresence(XMPPService xmppService, String jabberId)
- - Get the presence of a Jabber ID.
- param:
- the Jabber ID
- return:
- the presence information
-
+ - Get the presence of a Jabber ID.
+
- Parameters:
the
- Jabber ID
- Returns:
- the presence information
@@ -796,10 +832,10 @@
getPresence
- public static Presence getPresence(XMPPService xmppService, String jabberIdTo, String jabberIdFrom)
+ static Presence getPresence(XMPPService xmppService, String jabberIdTo, String jabberIdFrom)
- - Get the presence of a Jabber ID.
- param:
- jabberIdTo the Jabber ID to get the presence from
- param:
- jabberIdFrom the Jabber ID to use to send the presence request
- return:
- the presence information
-
+ - Get the presence of a Jabber ID.
+
- Parameters:
jabberIdTo
- the Jabber ID to get the presence fromjabberIdFrom
- the Jabber ID to use to send the presence request
- Returns:
- the presence information
@@ -807,10 +843,10 @@
getRecipients
- public static List getRecipients(def message)
+ static List getRecipients(def message)
- - Gets the list of recipients of this message in the form of a list of Jabber ID strings.
- return:
- a list of Jabber ID strings
-
+ - Gets the list of recipients of this message in the form of a list of Jabber ID strings.
+
- Returns:
- a list of Jabber ID strings
@@ -818,10 +854,10 @@
getXml
- public static GPathResult getXml(def message)
+ static GPathResult getXml(def message)
- - Get the XML content of this message (if it's an XML message) in the form of a DOM parsed with XmlSlurper.
- return:
- the slurped XML document
-
+ - Get the XML content of this message (if it's an XML message) in the form of a DOM parsed with XmlSlurper.
+
- Returns:
- the slurped XML document
@@ -829,7 +865,7 @@
isCase
- public static boolean isCase(MemcacheService memcache, Object key)
+ static boolean isCase(MemcacheService memcache, Object key)
- Shortcut to check whether a key is contained in the cache using the
in
operator:
key in memcache
@@ -841,7 +877,7 @@
isSuccessful
- public static boolean isSuccessful(SendResponse status)
+ static boolean isSuccessful(SendResponse status)
- Checks the status of the sending of the message was successful for all its recipients
@@ -852,7 +888,7 @@
leftShift
- public static Entity leftShift(Entity entity, Map params)
+ static Entity leftShift(Entity entity, Map params)
- Set the
Entity
properties with the key / value pairs of the map,
using the leftshift operator as follows:
@@ -865,7 +901,7 @@
leftShift
- public static TaskHandle leftShift(Queue selfQueue, Map params)
+ static TaskHandle leftShift(Queue selfQueue, Map params)
- Add a new task on the queue using a map for holding the task attributes instead of a TaskOptions builder object.
This method adds a
<<
operator on the Queue
for adding new tasks to it.
@@ -879,8 +915,8 @@
payload
taskName
url
- - param:
- params the map of task attributes
- return:
- a TaskHandle instance
-
+
+ - Parameters:
params
- the map of task attributes
- Returns:
- a TaskHandle instance
@@ -888,11 +924,11 @@
putAt
- public static void putAt(MemcacheService memcache, String key, Object value)
+ static void putAt(MemcacheService memcache, String key, Object value)
- Put an object into the cache, identified by its key, using the subscript notation:
-
memcache[key] = value
- param:
- key the key identifying the object to put in the cache
- param:
- value the value to put in the cache
-
+ memcache[key] = value
+ - Parameters:
key
- the key identifying the object to put in the cachevalue
- the value to put in the cache
@@ -900,11 +936,11 @@
putAt
- public static void putAt(MemcacheService memcache, Object key, Object value)
+ static void putAt(MemcacheService memcache, Object key, Object value)
- Put an object into the cache, identified by its key, using the subscript notation:
-
memcache[key] = value
- param:
- key the key identifying the object to put in the cache
- param:
- value the value to put in the cache
-
+ memcache[key] = value
+ - Parameters:
key
- the key identifying the object to put in the cachevalue
- the value to put in the cache
@@ -912,7 +948,7 @@
save
- public static Object save(Entity entity)
+ static Object save(Entity entity)
- Save this entity in the data store.
Usage:
entity.save()
@@ -924,7 +960,7 @@
send
- public static void send(MailService mailService, Map m)
+ static void send(MailService mailService, Map m)
- Additional
send()
method taking a map as parameter.
The map can contain the normal properties of the
@@ -938,7 +974,7 @@
send
- public static SendResponse send(XMPPService xmppService, Map msgAttr)
+ static SendResponse send(XMPPService xmppService, Map msgAttr)
- Send an XMPP/Jabber message with the XMPP service using a map of attributes to build the message.
@@ -950,8 +986,8 @@
('CHAT', 'ERROR', 'GROUPCHAT', 'HEADLINE', 'NORMAL')
- body: a String representing the raw text to send
- xml: a closure representing the XML you want to send (serialized using StreamingMarkupBuilder)
- - param:
- msgAttr a map of attributes as described
- return:
- an intance of SendResponse
-
+
+ - Parameters:
msgAttr
- a map of attributes as described
- Returns:
- an intance of SendResponse
@@ -959,10 +995,10 @@
sendInvitation
- public static void sendInvitation(XMPPService xmppService, String jabberId)
+ static void sendInvitation(XMPPService xmppService, String jabberId)
- - Send a chat invitation to a Jabber ID.
- param:
- the Jabber ID to invite
-
+ - Send a chat invitation to a Jabber ID.
+
- Parameters:
the
- Jabber ID to invite
@@ -970,10 +1006,10 @@
sendInvitation
- public static void sendInvitation(XMPPService xmppService, String jabberIdTo, String jabberIdFrom)
+ static void sendInvitation(XMPPService xmppService, String jabberIdTo, String jabberIdFrom)
- - Send a chat invitation to a Jabber ID from another Jabber ID.
- param:
- jabberIdTo the Jabber ID to invite
- param:
- jabberIdFrom the Jabber ID to use to send the invitation request
-
+ - Send a chat invitation to a Jabber ID from another Jabber ID.
+
- Parameters:
jabberIdTo
- the Jabber ID to invitejabberIdFrom
- the Jabber ID to use to send the invitation request
@@ -981,14 +1017,14 @@
sendToAdmins
- public static void sendToAdmins(MailService mailService, Map m)
+ static void sendToAdmins(MailService mailService, Map m)
- Additional
sendToAdmins()
method for sending emails to the application admins.
This method is taking a map as parameter.
The map can contain the normal properties of the
- MailService.Message
class.- param:
- @throws groovy.lang.MissingPropertyException when the key doesn't correspond
+
MailService.Message
class.
+ - Parameters:
@throws
- groovy.lang.MissingPropertyException when the key doesn't correspond
to a property of the MailService.Message
class.
-
@@ -996,7 +1032,7 @@
set
- public static Object set(Entity entity, String name, Object value)
+ static void set(Entity entity, String name, Object value)
- Provides a shortcut notation to set a property of an entity.
Instead of writing
@@ -1013,7 +1049,7 @@
setAt
- public static Object setAt(Entity entity, String name, Object value)
+ static void setAt(Entity entity, String name, Object value)
- Provides a shortcut notation to set a property of an entity.
Instead of writing
@@ -1028,9 +1064,60 @@
+
+ withReader
+ static Object withReader(BlobKey selfKey, String encoding, Closure c)
+
+ - Creates a (buffered)
Reader
over the blob with a specified encoding.
+ The reader is passed as parameter of the closure.
+ This methods takes care of properly opening and closing the reader and underlying stream.
+ You can use this method as follows:
+
+ blobKey.withReader("UTF-8") { reader -> ... }
+
+ - Parameters:
selfKey
- a BlobKeyencoding
- the encoding used to read from the stream (UTF-8, etc.)c
- the closure to execute, passing in the stream as parameter of the closure
- Returns:
- the return value of the closure execution
+
+
+
+
+
+
+ withReader
+ static Object withReader(BlobKey selfKey, Closure c)
+
+ - Creates a (buffered)
Reader
over the blob using UTF-8 as default encoding.
+ The reader is passed as parameter of the closure.
+ This methods takes care of properly opening and closing the reader and underlying stream.
+ You can use this method as follows:
+
+ blobKey.withReader { reader -> ... }
+
+ - Parameters:
selfKey
- a BlobKeyencoding
- the encoding used to read from the stream (UTF-8, etc.)c
- the closure to execute, passing in the stream as parameter of the closure
- Returns:
- the return value of the closure execution
+
+
+
+
+
+
+ withStream
+ static Object withStream(BlobKey selfKey, Closure c)
+
+ - Creates an
InputStream
over the blob.
+ The stream is passed as parameter of the closure.
+ This methods takes care of properly opening and closing the stream.
+ You can use this method as follows:
+
+ blobKey.withStream { inputstream -> ... }
+
+ - Parameters:
selfKey
- a BlobKeyc
- the closure to execute, passing in the stream as parameter of the closure
- Returns:
- the return value of the closure execution
+
+
+
+
+
withTransaction
- public static Transaction withTransaction(DatastoreService service, Closure c)
+ static Transaction withTransaction(DatastoreService service, Closure c)
- With this method, transaction handling is done transparently.
The transaction is committed if the closure executed properly.
diff --git a/website/war/api/groovyx/gaelyk/GaelykIncomingEmailServlet.html b/website/war/api/groovyx/gaelyk/GaelykIncomingEmailServlet.html
index e35956f5..a80f2f77 100644
--- a/website/war/api/groovyx/gaelyk/GaelykIncomingEmailServlet.html
+++ b/website/war/api/groovyx/gaelyk/GaelykIncomingEmailServlet.html
@@ -6,9 +6,9 @@
-
-
GaelykIncomingEmailServlet (Gaelyk 0.4)
-
+
+GaelykIncomingEmailServlet (Gaelyk 0.4.1)
+
@@ -16,7 +16,7 @@
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="GaelykIncomingEmailServlet (Gaelyk 0.4)";
+ parent.document.title="GaelykIncomingEmailServlet (Gaelyk 0.4.1)";
}
}
@@ -91,13 +91,13 @@
groovyx.gaelyk
-Class GaelykIncomingEmailServlet
+[Groovy] Class GaelykIncomingEmailServlet
java.lang.Object
javax.servlet.GenericServlet
javax.servlet.http.HttpServlet
groovyx.gaelyk.GaelykIncomingEmailServlet
-public class GaelykIncomingEmailServlet
+class GaelykIncomingEmailServlet
extends HttpServlet
@@ -106,8 +106,8 @@
Servlet for handling incoming Email messages.
This servlet should be configured with a servlet mapping to the _ah/mail/*
as this is the hard-coded path Google App Engine uses.
- The start represents the name part of the email address of the sender (the part before the @ character)- author:
- Guillaume Laforge
-
+ The start represents the name part of the email address of the sender (the part before the @ character)
+ - Authors:
- Guillaume Laforge
@@ -169,19 +169,19 @@
Methods inherited from class HttpServlet
- service, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, destroy, log, log, hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll
+ service, log, log, init, init, destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
Methods inherited from class GenericServlet
- getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, destroy, log, log, service, hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll
+ log, log, init, init, destroy, service, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
Methods inherited from class Object
- hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll
+ wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
@@ -225,7 +225,7 @@
doPost
- public void doPost(HttpServletRequest req, HttpServletResponse res)
+ void doPost(HttpServletRequest req, HttpServletResponse res)
- Handles incoming Email messages.
diff --git a/website/war/api/groovyx/gaelyk/GaelykServlet.html b/website/war/api/groovyx/gaelyk/GaelykServlet.html
index 6907fddc..a16fc908 100644
--- a/website/war/api/groovyx/gaelyk/GaelykServlet.html
+++ b/website/war/api/groovyx/gaelyk/GaelykServlet.html
@@ -6,9 +6,9 @@
-
-GaelykServlet (Gaelyk 0.4)
-
+
+GaelykServlet (Gaelyk 0.4.1)
+
@@ -16,7 +16,7 @@
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="GaelykServlet (Gaelyk 0.4)";
+ parent.document.title="GaelykServlet (Gaelyk 0.4.1)";
}
}
@@ -91,7 +91,7 @@
groovyx.gaelyk
-Class GaelykServlet
+[Groovy] Class GaelykServlet
java.lang.Object
javax.servlet.GenericServlet
javax.servlet.http.HttpServlet
@@ -99,15 +99,15 @@
groovy.servlet.GroovyServlet
groovyx.gaelyk.GaelykServlet
-public class GaelykServlet
+class GaelykServlet
extends GroovyServlet
The Gaelyk servlet extends Groovy's own Groovy servlet
- to inject Google App Engine dedicated services in the binding of the Groolets.
- author:
- Marcel Overdijk
- author:
- Guillaume Laforge
- see:
- GroovyServlet
-
+ to inject Google App Engine dedicated services in the binding of the Groolets.
+ - Authors:
- Marcel Overdijk
- Guillaume Laforge
- See Also:
- GroovyServlet
@@ -209,31 +209,31 @@
Methods inherited from class GroovyServlet
- init, service, getResourceConnection, service, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, destroy, log, log, hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll
+ init, service, getResourceConnection, service, log, log, init, destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
Methods inherited from class AbstractHttpServlet
- getResourceConnection, init, service, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, destroy, log, log, hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll
+ init, getResourceConnection, service, log, log, init, destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
Methods inherited from class HttpServlet
- service, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, destroy, log, log, hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll
+ service, log, log, init, init, destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
Methods inherited from class GenericServlet
- getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, destroy, log, log, service, hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll
+ log, log, init, init, destroy, service, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
Methods inherited from class Object
- hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll
+ wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
@@ -278,7 +278,7 @@
init
@Override
-public void init(ServletConfig config)
+void init(ServletConfig config)
-
@@ -289,11 +289,11 @@
service
@Override
-public void service(HttpServletRequest request, HttpServletResponse response)
+void service(HttpServletRequest request, HttpServletResponse response)
- Service incoming requests applying the
GaelykCategory
- and the other categories defined by the installed plugins.- param:
- request the request
- param:
- response the response
- throws:
- IOException when anything goes wrong
-
+ and the other categories defined by the installed plugins.- throws:
- IOException when anything goes wrong
+ - Parameters:
request
- the requestresponse
- the response
@@ -304,8 +304,8 @@
@Override
protected void setVariables(ServletBinding binding)
- - Injects the default variables and GAE services in the binding of Groovlets
- param:
- binding the binding to enhance
-
+ - Injects the default variables and GAE services in the binding of Groovlets
+
- Parameters:
binding
- the binding to enhance
diff --git a/website/war/api/groovyx/gaelyk/GaelykTemplateServlet.html b/website/war/api/groovyx/gaelyk/GaelykTemplateServlet.html
index 122f2078..96e12fb6 100644
--- a/website/war/api/groovyx/gaelyk/GaelykTemplateServlet.html
+++ b/website/war/api/groovyx/gaelyk/GaelykTemplateServlet.html
@@ -6,9 +6,9 @@
-
-GaelykTemplateServlet (Gaelyk 0.4)
-
+
+GaelykTemplateServlet (Gaelyk 0.4.1)
+
@@ -16,7 +16,7 @@
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="GaelykTemplateServlet (Gaelyk 0.4)";
+ parent.document.title="GaelykTemplateServlet (Gaelyk 0.4.1)";
}
}
@@ -91,7 +91,7 @@
groovyx.gaelyk
-Class GaelykTemplateServlet
+[Groovy] Class GaelykTemplateServlet
java.lang.Object
javax.servlet.GenericServlet
javax.servlet.http.HttpServlet
@@ -99,15 +99,15 @@
groovy.servlet.TemplateServlet
groovyx.gaelyk.GaelykTemplateServlet
-public class GaelykTemplateServlet
+class GaelykTemplateServlet
extends TemplateServlet
The Gaelyk template servlet extends Groovy's own template servlet
- to inject Google App Engine dedicated services in the binding of the Groolets.
- author:
- Marcel Overdijk
- author:
- Guillaume Laforge
- see:
- TemplateServlet
-
+ to inject Google App Engine dedicated services in the binding of the Groolets.
+ - Authors:
- Marcel Overdijk
- Guillaume Laforge
- See Also:
- TemplateServlet
@@ -209,31 +209,31 @@
Methods inherited from class TemplateServlet
- init, service, getResourceConnection, service, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, destroy, log, log, hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll
+ init, service, getResourceConnection, service, log, log, init, destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
Methods inherited from class AbstractHttpServlet
- getResourceConnection, init, service, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, destroy, log, log, hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll
+ init, getResourceConnection, service, log, log, init, destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
Methods inherited from class HttpServlet
- service, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, destroy, log, log, hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll
+ service, log, log, init, init, destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
Methods inherited from class GenericServlet
- getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, destroy, log, log, service, hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll
+ log, log, init, init, destroy, service, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
Methods inherited from class Object
- hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll
+ wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
@@ -278,7 +278,7 @@
init
@Override
-public void init(ServletConfig config)
+void init(ServletConfig config)
-
@@ -289,11 +289,11 @@
service
@Override
-public void service(HttpServletRequest request, HttpServletResponse response)
+void service(HttpServletRequest request, HttpServletResponse response)
- Service incoming requests applying the
GaelykCategory
- and the other categories defined by the installed plugins.- param:
- request the request
- param:
- response the response
- throws:
- IOException when anything goes wrong
-
+ and the other categories defined by the installed plugins.- throws:
- IOException when anything goes wrong
+ - Parameters:
request
- the requestresponse
- the response
@@ -304,8 +304,8 @@
@Override
protected void setVariables(ServletBinding binding)
- - Injects the default variables and GAE services in the binding of templates
- param:
- binding the binding to enhance
-
+ - Injects the default variables and GAE services in the binding of templates
+
- Parameters:
binding
- the binding to enhance
diff --git a/website/war/api/groovyx/gaelyk/GaelykXmppServlet.html b/website/war/api/groovyx/gaelyk/GaelykXmppServlet.html
index b7dd2d65..3b55626c 100644
--- a/website/war/api/groovyx/gaelyk/GaelykXmppServlet.html
+++ b/website/war/api/groovyx/gaelyk/GaelykXmppServlet.html
@@ -6,9 +6,9 @@
-
-GaelykXmppServlet (Gaelyk 0.4)
-
+
+GaelykXmppServlet (Gaelyk 0.4.1)
+
@@ -16,7 +16,7 @@
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="GaelykXmppServlet (Gaelyk 0.4)";
+ parent.document.title="GaelykXmppServlet (Gaelyk 0.4.1)";
}
}
@@ -91,13 +91,13 @@
groovyx.gaelyk
-Class GaelykXmppServlet
+[Groovy] Class GaelykXmppServlet
java.lang.Object
javax.servlet.GenericServlet
javax.servlet.http.HttpServlet
groovyx.gaelyk.GaelykXmppServlet
-public class GaelykXmppServlet
+class GaelykXmppServlet
extends HttpServlet
@@ -105,8 +105,8 @@
Servlet for handling incoming XMPP/Jabber messages.
This servlet should be configured with a servlet mapping to the _ah/xmpp/message/chat/
- as this is the hard-coded path Google App Engine uses.
- author:
- Guillaume Laforge
-
+ as this is the hard-coded path Google App Engine uses.
+ - Authors:
- Guillaume Laforge
@@ -168,19 +168,19 @@
Methods inherited from class HttpServlet
- service, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, destroy, log, log, hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll
+ service, log, log, init, init, destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
Methods inherited from class GenericServlet
- getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, destroy, log, log, service, hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll
+ log, log, init, init, destroy, service, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
Methods inherited from class Object
- hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll
+ wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
@@ -224,7 +224,7 @@
doPost
- public void doPost(HttpServletRequest req, HttpServletResponse res)
+ void doPost(HttpServletRequest req, HttpServletResponse res)
- Handles XMPP incoming messages.
diff --git a/website/war/api/groovyx/gaelyk/QueueAccessor.html b/website/war/api/groovyx/gaelyk/QueueAccessor.html
index 9f813e5c..beb06fbf 100644
--- a/website/war/api/groovyx/gaelyk/QueueAccessor.html
+++ b/website/war/api/groovyx/gaelyk/QueueAccessor.html
@@ -6,9 +6,9 @@
-
-QueueAccessor (Gaelyk 0.4)
-
+
+QueueAccessor (Gaelyk 0.4.1)
+
@@ -16,7 +16,7 @@
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="QueueAccessor (Gaelyk 0.4)";
+ parent.document.title="QueueAccessor (Gaelyk 0.4.1)";
}
}
@@ -91,18 +91,18 @@
groovyx.gaelyk
-Class QueueAccessor
+[Groovy] Class QueueAccessor
java.lang.Object
groovyx.gaelyk.QueueAccessor
-public class QueueAccessor
+class QueueAccessor
Holder for queues providing a Groovy map-like syntax for accessing queues.
- The default queue is named 'default'.
- author:
- Guillaume Laforge
-
+ The default queue is named 'default'.
+ - Authors:
- Guillaume Laforge
@@ -174,7 +174,7 @@
Methods inherited from class Object
- hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll
+ wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
@@ -218,10 +218,10 @@
getAt
- public def getAt(String queueName)
+ def getAt(String queueName)
- - Retrieve a queue by its name using the subscript syntax:
queues['queueA']
.- param:
- the name of the queue to retrieve
- return:
- the queue identified by its name
-
+ - Retrieve a queue by its name using the subscript syntax:
queues['queueA']
.
+ - Parameters:
queueName
- the name of the queue to retrieve
- Returns:
- the queue identified by its name
@@ -229,10 +229,10 @@
getProperty
- public def getProperty(String queueName)
+ def getProperty(String queueName)
- - Retrieve a queue by its name using the property access notation:
queues.queueA
.- param:
- the name of the queue to retrieve
- return:
- the queue identified by its name
-
+ - Retrieve a queue by its name using the property access notation:
queues.queueA
.
+ - Parameters:
queueName
- the name of the queue to retrieve
- Returns:
- the queue identified by its name
diff --git a/website/war/api/groovyx/gaelyk/package-frame.html b/website/war/api/groovyx/gaelyk/package-frame.html
index 97066c17..7c7ef0af 100644
--- a/website/war/api/groovyx/gaelyk/package-frame.html
+++ b/website/war/api/groovyx/gaelyk/package-frame.html
@@ -23,7 +23,7 @@
Classes
-
GaelykBindingEnhancer
GaelykCategory
GaelykIncomingEmailServlet
GaelykServlet
GaelykTemplateServlet
GaelykXmppServlet
QueueAccessor
+
ExpirationTimeCategory
GaelykBindingEnhancer
GaelykCategory
GaelykIncomingEmailServlet
GaelykServlet
GaelykTemplateServlet
GaelykXmppServlet
QueueAccessor
@@ -33,5 +33,6 @@
+
diff --git a/website/war/api/groovyx/gaelyk/package-summary.html b/website/war/api/groovyx/gaelyk/package-summary.html
index 38e63c66..67aabbd1 100644
--- a/website/war/api/groovyx/gaelyk/package-summary.html
+++ b/website/war/api/groovyx/gaelyk/package-summary.html
@@ -2,7 +2,7 @@
-groovyx.gaelyk (Gaelyk 0.4)
+groovyx.gaelyk (Gaelyk 0.4.1)
@@ -10,7 +10,7 @@
Groovy Documentation
java.lang.Object groovy.lang.GroovyObjectSupport groovy.lang.Binding groovyx.gaelyk.plugins.LazyBinding
public class LazyBinding +class LazyBinding extends BindingImplementation of a lazy binding which returns a String - representing the name of a variable that was not bound
Methods inherited from class GroovyObjectSupport | |
---|---|
invokeMethod, getMetaClass, setMetaClass, setProperty, getProperty, hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll | |
setProperty, getProperty, invokeMethod, getMetaClass, setMetaClass, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
Methods inherited from class Object | |
---|---|
hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll | |
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
public def getVariable(String name)+
def getVariable(String name)
java.lang.Object groovy.lang.GroovyObjectSupport groovy.lang.Script groovyx.gaelyk.routes.RoutesBaseScript groovyx.gaelyk.plugins.PluginBaseScript
public abstract class PluginBaseScript +abstract class PluginBaseScript extends RoutesBaseScript- Base script class used for evaluating the plugin descriptors.
+ Property Summary | +|
---|---|
+ Map |
+
+ bindingVariables
+ + contributed binding variables + |
+
+ List |
+
+ categories
+ + contributed categories + |
+
Methods inherited from class GroovyObjectSupport | |
---|---|
invokeMethod, getMetaClass, setMetaClass, setProperty, getProperty, hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll | |
setProperty, getProperty, invokeMethod, getMetaClass, setMetaClass, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
Methods inherited from class Object | |
---|---|
hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll | |
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
+ Property Detail | +
---|
Map bindingVariables+
+
List categories+
+
public void binding(Closure c)+
void binding(Closure c)
c
- closure containing the new variables to add to the binding
public void categories(Class cats)+
void categories(Class cats)
cats
- vararg of categories to install
public void routes(Closure c)+
void routes(Closure c)
c
- closure containing the new route definitions
java.lang.Object groovyx.gaelyk.plugins.PluginsHandler
@Singleton(lazy = true) -public class PluginsHandler +class PluginsHandler
- Configure the installed plugins.
+ Property Summary | +|
---|---|
+ Map |
+
+ bindingVariables
+ + + |
+
+ List |
+
+ categories
+ + + |
+
+ List |
+
+ routes
+ + + |
+
enrich(Binding binding)
Add the variables in the binding, as defined by the plugin descriptors.
+ Property Detail | +
---|
Map bindingVariables+
+
List categories+
+
List routes+
+
public void enrich(Binding binding)+
void enrich(Binding binding)
binding
- the binding to add the variables to
public void initPlugins()+
void initPlugins()
protected List loadPluginsList()
java.lang.Object groovy.lang.GroovyObjectSupport groovy.lang.Script groovyx.gaelyk.plugins.PluginsListBaseScript
public abstract class PluginsListBaseScript +abstract class PluginsListBaseScript extends Script- Base script class used for listing the plugins to configure.
+ Property Summary | +|
---|---|
+ List |
+
+ plugins
+ + + |
+
Methods inherited from class GroovyObjectSupport | |
---|---|
invokeMethod, getMetaClass, setMetaClass, setProperty, getProperty, hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll | |
setProperty, getProperty, invokeMethod, getMetaClass, setMetaClass, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
Methods inherited from class Object | |
---|---|
hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll | |
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
+ Property Detail | +
---|
List plugins+
+
public void install(String pluginName)+
void install(String pluginName)
pluginName
- name of a plugin to be loaded
java.lang.Object groovyx.gaelyk.routes.HttpMethod
public enum HttpMethod +enum HttpMethod- Enum listing the various HTTP methods, as well as an
ALL
element matching all possible methods.
ALL
element matching all possible methods.
+ java.lang.Object groovyx.gaelyk.routes.RedirectionType
public enum RedirectionType +enum RedirectionType- Type of redirection for the URL rewriting: either "redirect" or "forward" to a new location.
java.lang.Object groovyx.gaelyk.routes.Route
public class Route +class Route- Representation of a route URL mapping.
+ Property Summary | +|
---|---|
+ int |
+
+ cacheExpiration
+ + The time in seconds the resource to stay in memcache + |
+
+ String |
+
+ destination
+ + The destination pattern when the route is matched + |
+
+ HttpMethod |
+
+ method
+ + The HTTP method used to reach that route + |
+
+ RedirectionType |
+
+ redirectionType
+ + Whether we're doing a redirect or a forward to the new location + |
+
+ String |
+
+ route
+ + The route pattern + |
+
Route(String route, String destination, HttpMethod method = HttpMethod.ALL, RedirectionType redirectionType = RedirectionType.FORWARD, Closure validator = null)
+ Route(String route, String destination, HttpMethod method = HttpMethod.ALL, RedirectionType redirectionType = RedirectionType.FORWARD, Closure validator = null, int cacheExpiration = 0)
Constructor taking a route, a destination, an HTTP method (optional), a redirection type (optional), and a closure for validating the variables against regular expression patterns.
@@ -213,7 +272,7 @@+ Property Detail | +
---|
int cacheExpiration+
+
String destination+
+
HttpMethod method+
+
RedirectionType redirectionType+
+
String route+
+
public Route(String route, String destination, HttpMethod method = HttpMethod.ALL, RedirectionType redirectionType = RedirectionType.FORWARD, Closure validator = null)+
Route(String route, String destination, HttpMethod method = HttpMethod.ALL, RedirectionType redirectionType = RedirectionType.FORWARD, Closure validator = null, int cacheExpiration = 0)
public static List extractParameters(String route)+
static List extractParameters(String route)
public def forUri(String uri)+
def forUri(String uri)
public String toString()+
String toString()
public static String transformRouteIntoRegex(String route)+
static String transformRouteIntoRegex(String route)
java.lang.Object groovy.lang.GroovyObjectSupport groovy.lang.Script groovyx.gaelyk.routes.RoutesBaseScript
public abstract class RoutesBaseScript +abstract class RoutesBaseScript extends Script- Base script class used for evaluating the routes.
+ Property Summary | +|
---|---|
+ List |
+
+ routes
+ + The list of routes available + |
+
Methods inherited from class GroovyObjectSupport | |
---|---|
invokeMethod, getMetaClass, setMetaClass, setProperty, getProperty, hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll | |
setProperty, getProperty, invokeMethod, getMetaClass, setMetaClass, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
Methods inherited from class Object | |
---|---|
hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll | |
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
+ Property Detail | +
---|
List routes+
+
public def all(Map m, String route)+
def all(Map m, String route)
public def delete(Map m, String route)+
def delete(Map m, String route)
public def get(Map m, String route)+
def get(Map m, String route)
public def post(Map m, String route)+
def post(Map m, String route)
public def put(Map m, String route)+
def put(Map m, String route)
java.lang.Object groovyx.gaelyk.routes.RoutesFilter
public class RoutesFilter +class RoutesFilter@@ -108,8 +108,8 @@
routes.location
init parameter in the declaration of the filter inweb.xml
.In development mode, routes will be reloaded automatically on each request, but when the application - is deployed on the Google cloud, all the routes will be set in stone.
public void destroy()+
void destroy()
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)+
void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
public void init(FilterConfig filterConfig)+
void init(FilterConfig filterConfig)