You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@shindig.apache.org by li...@apache.org on 2010/09/02 00:03:40 UTC
svn commit: r991727 [1/3] - in /shindig/trunk/java:
common/src/main/java/org/apache/shindig/auth/
common/src/main/java/org/apache/shindig/common/cache/
common/src/main/java/org/apache/shindig/common/cache/ehcache/
common/src/main/java/org/apache/shindi...
Author: lindner
Date: Wed Sep 1 22:03:35 2010
New Revision: 991727
URL: http://svn.apache.org/viewvc?rev=991727&view=rev
Log:
lots and lots of javadoc cleanups
Modified:
shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/AbstractSecurityToken.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/AnonymousAuthenticationHandler.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/AnonymousSecurityToken.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/BasicSecurityTokenCodec.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/BlobCrypterSecurityTokenCodec.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/DefaultSecurityTokenCodec.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/ForwardingSecurityToken.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/OAuthConstants.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/SecurityTokenCodec.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/common/cache/CacheProvider.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/common/cache/ehcache/EhCacheCacheProvider.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/common/servlet/HttpUtil.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/common/uri/Uri.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/common/xml/XmlException.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/ELTypeConverter.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/ExpressionProvider.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/Functions.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/RootELResolver.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperConversionModule.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperModule.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperProvider.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperTypeConverter.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/juel/JuelModule.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/juel/JuelProvider.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/juel/JuelTypeConverter.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/DataCollection.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/DataServiceServlet.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/Operation.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/RestfulCollection.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanAtomConverter.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanConverter.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanDelegator.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanFilter.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanXStreamConverter.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanXmlConverter.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/ClassFieldMapping.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/DataCollectionConverter.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/GuiceBeanConverter.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/GuiceBeanProvider.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/InterfaceClassMapper.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/InterfaceFieldAliasMapping.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/InterfaceFieldAliasingMapper.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/RestfullCollectionConverter.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/model/EnumImpl.java
shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/model/Exportablebean.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/BasicGadgetBlacklist.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/DefaultGadgetSpecFactory.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/RenderingContext.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/UserPrefs.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/ConfigContributor.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/CoreUtilConfigContributor.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/OsapiServicesConfigContributor.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/ShindigAuthConfigContributor.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/XhrwrapperConfigContributor.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/features/BrowserSpecificFeatureResource.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/http/HttpFetcher.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/http/HttpResponseMetadataHelper.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/http/RequestPipeline.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/AccessorInfo.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/BasicOAuthStoreConsumerKeyAndSecret.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/BasicOAuthStoreTokenIndex.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/GadgetOAuthCallbackGenerator.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/OAuthCallbackState.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/OAuthClientState.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/OAuthRequestException.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/SocialDataTags.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/caja/CajaCssParser.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/caja/CajaHtmlParser.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/caja/CajaHtmlSerializer.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/CajaResponseRewriter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/GadgetRewritersProvider.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/RenderModule.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/SanitizingProxyUriManager.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/SanitizingResponseRewriter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/AbsolutePathReferenceRewriter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/AbsolutePathReferenceVisitor.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/AccelResponseRewriterRegistry.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/BaseTagRemoverRewriter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/CaptureRewriter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ConcatVisitor.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ContentTypeCharsetRemoverRewriter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ContentTypeCharsetRemoverVisitor.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/CssResponseRewriter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/DefaultResponseRewriterRegistry.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/DomWalker.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/OsTemplateXmlLoaderRewriter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/PipelineDataGadgetRewriter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ProxyingContentRewriter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ProxyingVisitor.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ResourceMutateVisitor.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ResponseRewriter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ResponseRewriterRegistry.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ScriptConcatContentRewriter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleAdjacencyContentRewriter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleAdjacencyVisitor.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleConcatContentRewriter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagExtractorContentRewriter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagExtractorVisitor.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagProxyEmbeddedUrlsRewriter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagProxyEmbeddedUrlsVisitor.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/AccelHandler.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/CajaContentRewriter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/GadgetsHandler.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/GadgetsHandlerApi.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/GadgetsHandlerService.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/HtmlAccelServlet.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/HttpRequestHandler.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/OAuthCallbackServlet.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/ServletUtil.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/spec/GadgetSpec.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/spec/Icon.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/TemplateProcessor.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/tags/AbstractTagRegistry.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/tags/DefaultTagRegistry.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/tags/IfTagHandler.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/AccelUriManager.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/AllJsIframeVersioner.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/ConcatUriManager.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultAccelUriManager.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultConcatUriManager.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultIframeUriManager.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultProxyUriManager.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/HashShaLockedDomainPrefixGenerator.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/IframeUriManager.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/JsUriManager.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/LockedDomainPrefixGenerator.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/OAuthUriManager.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/ProxyUriBase.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/ProxyUriManager.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriCommon.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriModule.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriStatus.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriUtils.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/MessageSubstituter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/ModuleSubstituter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/Substituter.java
shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/SubstituterModule.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/AccountImpl.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/ActivityImpl.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/AddressImpl.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/AlbumImpl.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/BodyTypeImpl.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/GroupImpl.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/ListFieldImpl.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/MediaItemImpl.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/MessageCollectionImpl.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/MessageImpl.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/NameImpl.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/OrganizationImpl.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/oauth/AuthenticationHandlerProvider.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/oauth/OAuthSecurityToken.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Activity.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Address.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Album.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/BodyType.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Drinker.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Group.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/LookingFor.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/MessageCollection.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Name.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/NetworkPresence.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Organization.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Url.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/oauth/OAuthDataStore.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/ActivityHandler.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/AlbumHandler.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/AppDataHandler.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/GroupHandler.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/MediaItemHandler.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/MessageHandler.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/PersonHandler.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/AlbumService.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/CollectionOptions.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/GroupId.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/GroupService.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/MediaItemService.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/PersonService.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/UserId.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/oauth/SampleOAuthDataStore.java
shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/spi/JsonDbOpensocialService.java
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/AbstractSecurityToken.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/AbstractSecurityToken.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/AbstractSecurityToken.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/AbstractSecurityToken.java Wed Sep 1 22:03:35 2010
@@ -20,7 +20,8 @@ package org.apache.shindig.auth;
/**
* A base class for SecurityToken Implementations. Currently provides an isExpired() method
- *
+ *
+ * @since 2.0.0
*/
public abstract class AbstractSecurityToken implements SecurityToken {
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/AnonymousAuthenticationHandler.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/AnonymousAuthenticationHandler.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/AnonymousAuthenticationHandler.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/AnonymousAuthenticationHandler.java Wed Sep 1 22:03:35 2010
@@ -22,6 +22,9 @@ import com.google.inject.name.Named;
import javax.servlet.http.HttpServletRequest;
+/**
+ * Handled Anonymous Authentication, including returning an "anonymous" security token.
+ */
public class AnonymousAuthenticationHandler implements AuthenticationHandler {
public static final String ALLOW_UNAUTHENTICATED = "shindig.allowUnauthenticated";
private final boolean allowUnauthenticated;
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/AnonymousSecurityToken.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/AnonymousSecurityToken.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/AnonymousSecurityToken.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/AnonymousSecurityToken.java Wed Sep 1 22:03:35 2010
@@ -22,7 +22,6 @@ import org.apache.shindig.config.Contain
/**
* A special class of Token representing the anonymous viewer/owner
- *
*/
public class AnonymousSecurityToken extends AbstractSecurityToken implements SecurityToken {
private final String container;
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/BasicSecurityTokenCodec.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/BasicSecurityTokenCodec.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/BasicSecurityTokenCodec.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/BasicSecurityTokenCodec.java Wed Sep 1 22:03:35 2010
@@ -30,6 +30,8 @@ import java.util.Map;
/**
* A SecurityTokenCodec implementation that just provides dummy data to satisfy
* tests and API calls. Do not use this for any security applications.
+ *
+ * @since 2.0.0
*/
@Singleton
public class BasicSecurityTokenCodec implements SecurityTokenCodec {
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/BlobCrypterSecurityTokenCodec.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/BlobCrypterSecurityTokenCodec.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/BlobCrypterSecurityTokenCodec.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/BlobCrypterSecurityTokenCodec.java Wed Sep 1 22:03:35 2010
@@ -44,6 +44,8 @@ import java.util.Map;
* dd if=/dev/random bs=32 count=1 | openssl base64 > /tmp/key.txt
* </pre>
* Wire format is "<container>:<encrypted-and-signed-token>"
+ *
+ * @since 2.0.0
*/
@Singleton
public class BlobCrypterSecurityTokenCodec implements SecurityTokenCodec {
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/DefaultSecurityTokenCodec.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/DefaultSecurityTokenCodec.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/DefaultSecurityTokenCodec.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/DefaultSecurityTokenCodec.java Wed Sep 1 22:03:35 2010
@@ -39,6 +39,8 @@ import java.util.Map;
* The insecure implementation is BasicSecurityTokenCodec.
*
* The secure implementation is BlobCrypterSecurityTokenCodec.
+ *
+ * @since 2.0.0
*/
@Singleton
public class DefaultSecurityTokenCodec implements SecurityTokenCodec {
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/ForwardingSecurityToken.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/ForwardingSecurityToken.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/ForwardingSecurityToken.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/ForwardingSecurityToken.java Wed Sep 1 22:03:35 2010
@@ -21,6 +21,8 @@ package org.apache.shindig.auth;
/**
* A SecurityToken that forwards all methods calls to another token. Subclasses should override
* one or more methods to change or add behavior.
+ *
+ * @since 2.0.0
*/
public abstract class ForwardingSecurityToken implements SecurityToken {
SecurityToken delegate;
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/OAuthConstants.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/OAuthConstants.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/OAuthConstants.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/OAuthConstants.java Wed Sep 1 22:03:35 2010
@@ -19,6 +19,9 @@
package org.apache.shindig.auth;
+/**
+ * OAuth constants not found in the upstream OAuth library
+ */
public final class OAuthConstants {
private OAuthConstants() {}
public static final String OAUTH_SESSION_HANDLE = "oauth_session_handle";
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/SecurityTokenCodec.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/SecurityTokenCodec.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/SecurityTokenCodec.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/auth/SecurityTokenCodec.java Wed Sep 1 22:03:35 2010
@@ -24,6 +24,8 @@ import java.util.Map;
/**
* Handles verification of gadget security tokens.
+ *
+ * @since 2.0.0
*/
@ImplementedBy(DefaultSecurityTokenCodec.class)
public interface SecurityTokenCodec {
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/common/cache/CacheProvider.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/common/cache/CacheProvider.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/common/cache/CacheProvider.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/common/cache/CacheProvider.java Wed Sep 1 22:03:35 2010
@@ -19,6 +19,9 @@ package org.apache.shindig.common.cache;
import com.google.inject.ImplementedBy;
+/**
+ * Interface for Shindig caches.
+ */
@ImplementedBy(LruCacheProvider.class)
public interface CacheProvider {
/**
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/common/cache/ehcache/EhCacheCacheProvider.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/common/cache/ehcache/EhCacheCacheProvider.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/common/cache/ehcache/EhCacheCacheProvider.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/common/cache/ehcache/EhCacheCacheProvider.java Wed Sep 1 22:03:35 2010
@@ -39,6 +39,10 @@ import java.util.concurrent.ConcurrentMa
import java.util.logging.Level;
import java.util.logging.Logger;
+/**
+ * Cache interface based on ehcache
+ * @see http://www.ehcache.org
+ */
public class EhCacheCacheProvider implements CacheProvider {
private static final Logger LOG = Logger.getLogger(EhCacheCacheProvider.class.getName());
private final CacheManager cacheManager;
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/common/servlet/HttpUtil.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/common/servlet/HttpUtil.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/common/servlet/HttpUtil.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/common/servlet/HttpUtil.java Wed Sep 1 22:03:35 2010
@@ -170,4 +170,4 @@ public final class HttpUtil {
resp.addHeader(ACCESS_CONTROL_ALLOW_ORIGIN_HEADER, origin);
}
}
-}
\ No newline at end of file
+}
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/common/uri/Uri.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/common/uri/Uri.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/common/uri/Uri.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/common/uri/Uri.java Wed Sep 1 22:03:35 2010
@@ -32,11 +32,11 @@ import java.util.List;
import java.util.Map;
/**
-* Represents a Uniform Resource Identifier (URI) reference as defined by <a
-* href="http://tools.ietf.org/html/rfc3986">RFC 3986</a>.
-*
-* Assumes that all url components are UTF-8 encoded.
-*/
+ * Represents a Uniform Resource Identifier (URI) reference as defined by <a
+ * href="http://tools.ietf.org/html/rfc3986">RFC 3986</a>.
+ *
+ * Assumes that all url components are UTF-8 encoded.
+ */
public final class Uri {
private final String text;
private final String scheme;
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/common/xml/XmlException.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/common/xml/XmlException.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/common/xml/XmlException.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/common/xml/XmlException.java Wed Sep 1 22:03:35 2010
@@ -17,6 +17,9 @@
*/
package org.apache.shindig.common.xml;
+/**
+ * Exception throw by shindig XML parsing utility routines
+ */
public class XmlException extends Exception {
public XmlException(String message, Exception cause) {
super(message, cause);
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/ELTypeConverter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/ELTypeConverter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/ELTypeConverter.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/ELTypeConverter.java Wed Sep 1 22:03:35 2010
@@ -19,7 +19,9 @@
package org.apache.shindig.expressions;
/**
- * Expression Language type conversion interface.
+ * Expression Language type conversion interface.
+ *
+ * @since 2.0.0
*/
import javax.el.ELException;
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/ExpressionProvider.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/ExpressionProvider.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/ExpressionProvider.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/ExpressionProvider.java Wed Sep 1 22:03:35 2010
@@ -25,6 +25,10 @@ import org.apache.shindig.expressions.ju
import com.google.inject.ImplementedBy;
+/**
+ * Provider for an expression handler Juel or Jasper
+ * @since 2.0.0
+ */
@ImplementedBy(JuelProvider.class)
public interface ExpressionProvider {
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/Functions.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/Functions.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/Functions.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/Functions.java Wed Sep 1 22:03:35 2010
@@ -42,7 +42,7 @@ import com.google.inject.Inject;
* of method names.
* <p>
* The default Guice instance of the Functions class has the
- * {@link OpensocialFunctions} methods registered.
+ * {@link OpensocialFunctions} methods registered.
*/
@ImplementedBy(Functions.DefaultFunctions.class)
public class Functions extends FunctionMapper {
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/RootELResolver.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/RootELResolver.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/RootELResolver.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/RootELResolver.java Wed Sep 1 22:03:35 2010
@@ -31,9 +31,9 @@ import com.google.common.collect.Immutab
* ELResolver implementation that adds a map of top-level variables.
* New variables can be inserted after creation with:
* {@code context.getELResolver().setValue(context, null, name, value);}
- *
+ *
* TODO: should this be read-only?
- *
+ *
* @see Expressions#newELContext(ELResolver...)
*/
public class RootELResolver extends ELResolver {
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperConversionModule.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperConversionModule.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperConversionModule.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperConversionModule.java Wed Sep 1 22:03:35 2010
@@ -26,6 +26,8 @@ import com.google.inject.Scopes;
/**
* Creates a module to supply a Jasper Type Converter
+ *
+ * @since 2.0.0
*/
public class JasperConversionModule extends AbstractModule {
@Override
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperModule.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperModule.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperModule.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperModule.java Wed Sep 1 22:03:35 2010
@@ -25,6 +25,8 @@ import com.google.inject.Scopes;
/**
* Creates a module to supply a Jasper Provider
+ *
+ * @since 2.0.0
*/
public class JasperModule extends AbstractModule {
@Override
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperProvider.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperProvider.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperProvider.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperProvider.java Wed Sep 1 22:03:35 2010
@@ -25,6 +25,10 @@ import org.apache.shindig.common.cache.C
import org.apache.shindig.expressions.ELTypeConverter;
import org.apache.shindig.expressions.ExpressionProvider;
+/**
+ * A Provider for Jasper Expression processing
+ * @since 2.0.0
+ */
public class JasperProvider implements ExpressionProvider {
public ExpressionFactory newExpressionFactory(CacheProvider cacheProvider,
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperTypeConverter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperTypeConverter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperTypeConverter.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/jasper/JasperTypeConverter.java Wed Sep 1 22:03:35 2010
@@ -21,6 +21,10 @@ package org.apache.shindig.expressions.j
import org.apache.shindig.expressions.ShindigTypeConverter;
import org.json.JSONArray;
+/**
+ * Jasper Implementation of a ShindigTypeConverter
+ * @since 2.0.0
+ */
public class JasperTypeConverter extends ShindigTypeConverter {
@Override
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/juel/JuelModule.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/juel/JuelModule.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/juel/JuelModule.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/juel/JuelModule.java Wed Sep 1 22:03:35 2010
@@ -25,6 +25,8 @@ import com.google.inject.Scopes;
/**
* Creates a module to supply a Juel Provider
+ *
+ * @since 2.0.0
*/
public class JuelModule extends AbstractModule {
@Override
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/juel/JuelProvider.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/juel/JuelProvider.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/juel/JuelProvider.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/juel/JuelProvider.java Wed Sep 1 22:03:35 2010
@@ -33,6 +33,10 @@ import org.apache.shindig.common.cache.C
import org.apache.shindig.expressions.ELTypeConverter;
import org.apache.shindig.expressions.ExpressionProvider;
+/**
+ * A provider for a Juel based Expression Implementation
+ * @since 2.0.0
+ */
public class JuelProvider implements ExpressionProvider {
private static final String EXPRESSION_CACHE = "expressions";
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/juel/JuelTypeConverter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/juel/JuelTypeConverter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/juel/JuelTypeConverter.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/expressions/juel/JuelTypeConverter.java Wed Sep 1 22:03:35 2010
@@ -24,6 +24,10 @@ import org.apache.shindig.expressions.Sh
import de.odysseus.el.misc.TypeConverter;
+/**
+ * A converter used by Juel
+ * @since 2.0.0
+ */
public class JuelTypeConverter extends ShindigTypeConverter implements
TypeConverter {
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/DataCollection.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/DataCollection.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/DataCollection.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/DataCollection.java Wed Sep 1 22:03:35 2010
@@ -19,6 +19,9 @@ package org.apache.shindig.protocol;
import java.util.Map;
+/**
+ * Wrapper class used for data responses.
+ */
public class DataCollection {
private Map<String, Map<String, String>> entry;
@@ -34,4 +37,4 @@ public class DataCollection {
this.entry = entry;
}
-}
\ No newline at end of file
+}
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/DataServiceServlet.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/DataServiceServlet.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/DataServiceServlet.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/DataServiceServlet.java Wed Sep 1 22:03:35 2010
@@ -36,6 +36,9 @@ import java.util.concurrent.Future;
import java.util.logging.Level;
import java.util.logging.Logger;
+/**
+ * Servlet used to process REST requests (/rest/* etc.)
+ */
public class DataServiceServlet extends ApiServlet {
private static final Logger LOG = Logger.getLogger(DataServiceServlet.class.getName());
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/Operation.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/Operation.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/Operation.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/Operation.java Wed Sep 1 22:03:35 2010
@@ -25,7 +25,6 @@ import java.lang.annotation.Target;
/**
* Annotates a method on a ServiceHandler which expose a REST/RPC operation
* The name of the annotated method is the literal name of the method for JSON-RPC
- *
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/RestfulCollection.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/RestfulCollection.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/RestfulCollection.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/RestfulCollection.java Wed Sep 1 22:03:35 2010
@@ -19,6 +19,9 @@ package org.apache.shindig.protocol;
import java.util.List;
+/**
+ * Data structure representing a Rest response.
+ */
public class RestfulCollection<T> {
private List<T> entry;
private int startIndex;
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanAtomConverter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanAtomConverter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanAtomConverter.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanAtomConverter.java Wed Sep 1 22:03:35 2010
@@ -32,6 +32,9 @@ import java.util.logging.Level;
import java.util.logging.Logger;
// TODO: This does not produce valid atom sytnax yet
+/**
+ * Converts a Bean into Atom-like syntax.
+ */
public class BeanAtomConverter implements BeanConverter {
private static final Logger LOG =
Logger.getLogger(BeanAtomConverter.class.getName());
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanConverter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanConverter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanConverter.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanConverter.java Wed Sep 1 22:03:35 2010
@@ -19,11 +19,15 @@ package org.apache.shindig.protocol.conv
import java.io.IOException;
+/**
+ * Interface for bean conversion classes
+ */
public interface BeanConverter {
<T> T convertToObject(String string, Class<T> className);
String convertToString(Object pojo);
+ /** @return the content type of the converted data */
String getContentType();
/**
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanDelegator.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanDelegator.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanDelegator.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanDelegator.java Wed Sep 1 22:03:35 2010
@@ -45,6 +45,8 @@ import java.util.Map;
* warn us if actual implementation change and break the API.
* Delegation support composition, and will create a proxy for fields according
* To table of classes to proxy.
+ *
+ * @since 2.0.0
*/
public class BeanDelegator {
@@ -96,7 +98,7 @@ public class BeanDelegator {
// Proxy each item in a map (map key is not proxied)
if (source instanceof Map<?, ?>) {
Map<?, ?> mapSource = (Map<?, ?>) source;
- if (mapSource.size() > 0 && delegatedClasses.containsKey(
+ if (!mapSource.isEmpty() && delegatedClasses.containsKey(
mapSource.values().iterator().next().getClass())) {
// Convert Map:
ImmutableMap.Builder<Object, Object> mapBuilder = ImmutableMap.builder();
@@ -112,7 +114,7 @@ public class BeanDelegator {
// Proxy each item in a list
if (source instanceof List<?>) {
List<?> listSource = (List<?>) source;
- if (listSource.size() > 0 && delegatedClasses.containsKey(
+ if (!listSource.isEmpty() && delegatedClasses.containsKey(
listSource.get(0).getClass())) {
// Convert Map:
ImmutableList.Builder<Object> listBuilder = ImmutableList.builder();
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanFilter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanFilter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanFilter.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanFilter.java Wed Sep 1 22:03:35 2010
@@ -52,6 +52,8 @@ import java.util.Set;
* Note this code create a new object for each filtered object.
* Filtering can be done also using cglib.InterfaceMaker and reflect.Proxy.makeProxyInstance
* That results with an object that have same finger print as source, but cannot be cast to it.
+ *
+ * @since 2.0.0
*/
public class BeanFilter {
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanXStreamConverter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanXStreamConverter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanXStreamConverter.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanXStreamConverter.java Wed Sep 1 22:03:35 2010
@@ -39,6 +39,9 @@ import java.util.Map;
import java.util.logging.Logger;
import java.util.logging.Level;
+/**
+ * Converts to/from XML format using XStream
+ */
public class BeanXStreamConverter implements BeanConverter {
public static final String XML_DECL = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>";
private static final XStreamConfiguration.ConverterSet[] MAPPER_SCOPES = {
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanXmlConverter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanXmlConverter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanXmlConverter.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/BeanXmlConverter.java Wed Sep 1 22:03:35 2010
@@ -31,6 +31,9 @@ import java.io.StringWriter;
import java.util.logging.Level;
import java.util.logging.Logger;
+/**
+ * Converts to/from XML format using betwixt
+ */
public class BeanXmlConverter implements BeanConverter {
private static final Logger LOG =
Logger.getLogger(BeanXmlConverter.class.getName());
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/ClassFieldMapping.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/ClassFieldMapping.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/ClassFieldMapping.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/ClassFieldMapping.java Wed Sep 1 22:03:35 2010
@@ -50,9 +50,6 @@ package org.apache.shindig.protocol.conv
*
*
*/
-/**
- *
- */
public class ClassFieldMapping {
/**
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/DataCollectionConverter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/DataCollectionConverter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/DataCollectionConverter.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/DataCollectionConverter.java Wed Sep 1 22:03:35 2010
@@ -33,7 +33,6 @@ import java.util.Map.Entry;
/**
* This converter changes the way in which a collection is serialized
- *
*/
public class DataCollectionConverter extends AbstractCollectionConverter {
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/GuiceBeanConverter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/GuiceBeanConverter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/GuiceBeanConverter.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/GuiceBeanConverter.java Wed Sep 1 22:03:35 2010
@@ -32,7 +32,7 @@ import com.thoughtworks.xstream.mapper.M
import java.util.Collection;
/**
- *
+ * Bean converter that uses Guice bindings to correctly convert
*/
public class GuiceBeanConverter implements Converter {
private Mapper mapper;
@@ -52,7 +52,7 @@ public class GuiceBeanConverter implemen
* need stricter checks, subclass JavaBeanConverter
*/
// Base API is inherently unchecked
- @SuppressWarnings("unchecked")
+
public boolean canConvert(Class type) {
while (true) {
if (type == null) {
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/GuiceBeanProvider.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/GuiceBeanProvider.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/GuiceBeanProvider.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/GuiceBeanProvider.java Wed Sep 1 22:03:35 2010
@@ -36,7 +36,7 @@ import com.google.inject.Injector;
import com.thoughtworks.xstream.converters.reflection.ObjectAccessException;
/**
- *
+ * GuiceBeanProvider class.
*/
public class GuiceBeanProvider {
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/InterfaceClassMapper.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/InterfaceClassMapper.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/InterfaceClassMapper.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/InterfaceClassMapper.java Wed Sep 1 22:03:35 2010
@@ -37,7 +37,6 @@ import java.util.logging.Level;
* as the reference class and then ArrayList and Set would both be mapped to the
* same element.
*/
-
public class InterfaceClassMapper extends MapperWrapper {
/**
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/InterfaceFieldAliasMapping.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/InterfaceFieldAliasMapping.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/InterfaceFieldAliasMapping.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/InterfaceFieldAliasMapping.java Wed Sep 1 22:03:35 2010
@@ -18,7 +18,7 @@
package org.apache.shindig.protocol.conversion.xstream;
/**
- *
+ * Maps of Interfaces to Aliases used by {@link org.apache.shindig.protocol.conversion.BeanXStreamConverter}
*/
public class InterfaceFieldAliasMapping {
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/InterfaceFieldAliasingMapper.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/InterfaceFieldAliasingMapper.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/InterfaceFieldAliasingMapper.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/InterfaceFieldAliasingMapper.java Wed Sep 1 22:03:35 2010
@@ -26,7 +26,7 @@ import java.util.List;
import java.util.Map;
/**
- *
+ * Maps Interfaces to Aliases used by {@link org.apache.shindig.protocol.conversion.BeanXStreamConverter}
*/
public class InterfaceFieldAliasingMapper extends MapperWrapper {
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/RestfullCollectionConverter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/RestfullCollectionConverter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/RestfullCollectionConverter.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/conversion/xstream/RestfullCollectionConverter.java Wed Sep 1 22:03:35 2010
@@ -28,7 +28,6 @@ import com.thoughtworks.xstream.mapper.M
/**
* This converter changes the way in which a collection is serialized
- *
*/
public class RestfullCollectionConverter extends AbstractCollectionConverter {
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/model/EnumImpl.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/model/EnumImpl.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/model/EnumImpl.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/model/EnumImpl.java Wed Sep 1 22:03:35 2010
@@ -17,6 +17,9 @@
*/
package org.apache.shindig.protocol.model;
+/**
+ * Implementation of the Enum interface
+ */
public final class EnumImpl<E extends Enum.EnumKey> implements Enum<E> {
private String displayValue;
private E value = null;
@@ -55,5 +58,4 @@ public final class EnumImpl<E extends En
public void setValue(E value) {
this.value = value;
}
-
}
Modified: shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/model/Exportablebean.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/model/Exportablebean.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/model/Exportablebean.java (original)
+++ shindig/trunk/java/common/src/main/java/org/apache/shindig/protocol/model/Exportablebean.java Wed Sep 1 22:03:35 2010
@@ -24,7 +24,8 @@ import java.lang.annotation.RetentionPol
import java.lang.annotation.Target;
/**
- *
+ * Annotation used by {@link org.apache.shindig.protocol.conversion.xstream.GuiceBeanConverter} to
+ * determine whether data from a getter is exposed.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/BasicGadgetBlacklist.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/BasicGadgetBlacklist.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/BasicGadgetBlacklist.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/BasicGadgetBlacklist.java Wed Sep 1 22:03:35 2010
@@ -55,7 +55,6 @@ import java.util.regex.Pattern;
*
* # Block all gadgets from the baz.com domain (including subdomains)
* REGEXP http://[^/]*baz.com/.*
- *
*/
@Singleton
public class BasicGadgetBlacklist implements GadgetBlacklist {
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/DefaultGadgetSpecFactory.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/DefaultGadgetSpecFactory.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/DefaultGadgetSpecFactory.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/DefaultGadgetSpecFactory.java Wed Sep 1 22:03:35 2010
@@ -93,4 +93,4 @@ public class DefaultGadgetSpecFactory ex
Element element = XmlUtil.parse(content);
return new GadgetSpec(query.getSpecUri(), element, content);
}
-}
\ No newline at end of file
+}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/RenderingContext.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/RenderingContext.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/RenderingContext.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/RenderingContext.java Wed Sep 1 22:03:35 2010
@@ -17,6 +17,9 @@
*/
package org.apache.shindig.gadgets;
+/**
+ * Defines where the gadget is being rendered.
+ */
public enum RenderingContext {
// Used when rendering gadgets (iframes or inline).
// TODO: rename this to "RENDER_GADGET"?
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/UserPrefs.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/UserPrefs.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/UserPrefs.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/UserPrefs.java Wed Sep 1 22:03:35 2010
@@ -22,6 +22,9 @@ import com.google.common.collect.Immutab
import java.util.Collections;
import java.util.Map;
+/**
+ * Data structure representing gadget user preferences.
+ */
public class UserPrefs {
/**
* Convenience representation of an empty pref set.
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/ConfigContributor.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/ConfigContributor.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/ConfigContributor.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/ConfigContributor.java Wed Sep 1 22:03:35 2010
@@ -22,6 +22,10 @@ import org.apache.shindig.gadgets.Gadget
import java.util.Map;
+/**
+ * Interface used by java classes that can inject javascript configuration information
+ * @since 2.0.0
+ */
public interface ConfigContributor {
/**
* Contribute configuration values for a specific gadget in an iframe.
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/CoreUtilConfigContributor.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/CoreUtilConfigContributor.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/CoreUtilConfigContributor.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/CoreUtilConfigContributor.java Wed Sep 1 22:03:35 2010
@@ -33,6 +33,8 @@ import java.util.Set;
/**
* Populates the core.util configuration, which at present includes the list
* of features that are supported.
+ *
+ * @since 2.0.0
*/
@Singleton
public class CoreUtilConfigContributor implements ConfigContributor {
@@ -78,4 +80,4 @@ public class CoreUtilConfigContributor i
public void contribute(Map<String,Object> config, String container, String host) {
// not used for container configuration
}
-}
\ No newline at end of file
+}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/OsapiServicesConfigContributor.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/OsapiServicesConfigContributor.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/OsapiServicesConfigContributor.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/OsapiServicesConfigContributor.java Wed Sep 1 22:03:35 2010
@@ -34,6 +34,8 @@ import java.util.Map;
* TODO osapi.services as a configuration parameter does not
* match a specific feature. It would be better to store this as
* 'osapi:{services: {...}}}
+ *
+ * @since 2.0.0
*/
@Singleton
public class OsapiServicesConfigContributor implements ConfigContributor {
@@ -66,4 +68,4 @@ public class OsapiServicesConfigContribu
config.put("osapi.services", endpoints);
}
}
-}
\ No newline at end of file
+}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/ShindigAuthConfigContributor.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/ShindigAuthConfigContributor.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/ShindigAuthConfigContributor.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/ShindigAuthConfigContributor.java Wed Sep 1 22:03:35 2010
@@ -33,6 +33,11 @@ import org.apache.shindig.gadgets.config
import java.util.Map;
@Singleton
+/**
+ * Injects auth configuration information for gadgets.config
+ *
+ * @since 2.0.0
+ */
public class ShindigAuthConfigContributor implements ConfigContributor {
private SecurityTokenCodec securityTokenCodec;
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/XhrwrapperConfigContributor.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/XhrwrapperConfigContributor.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/XhrwrapperConfigContributor.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/config/XhrwrapperConfigContributor.java Wed Sep 1 22:03:35 2010
@@ -31,6 +31,8 @@ import java.util.Map;
/**
* Provides config support for the xhrwrapper feature.
+ *
+ * @since 2.0.0
*/
@Singleton
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/features/BrowserSpecificFeatureResource.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/features/BrowserSpecificFeatureResource.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/features/BrowserSpecificFeatureResource.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/features/BrowserSpecificFeatureResource.java Wed Sep 1 22:03:35 2010
@@ -33,28 +33,28 @@ import java.util.Map;
/**
* A FeatureResource that supports being supplied only to certain browsers.
- *
+ *
* This is optional functionality, activated by the browser="..." attribute on
* a <script> element. That attribute's value is interpreted as a
* comma-separated list of BROWSER-versionKey matchers.
- *
+ *
* BROWSER must match (case-insensitive) the list of UserAgent.Browser enum values
* eg. "MSIE" or "FIREFOX".
- *
+ *
* versionKey is OPERATORversionNumber, where OPERATOR may be one of:
* ^ - regex
* = - exact match
* >, >=, <, <= - greater than/less than matches
* [no operator] - exact match
- *
+ *
* If no browser="..." attribute is specified, the resource always matches. Otherwise,
* if ANY of the browser-versionKey matchers match, the resource matches. In such case,
* the delegate FeatureResource's content methods are consulted. Otherwise, "" is returned
* for content.
- *
+ *
* Example:
* browser="FireFox->=3, MSIE-6.0 would match FireFox 3.x.y (any) and IE 6.0 (only).
- *
+ *
* To activate this capability, you may use the provided Loader class and bind it
* as your FeatureResourceLoader implementation; or build your own that wraps its resources
* in BrowserSpecificFeatureResource.
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/http/HttpFetcher.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/http/HttpFetcher.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/http/HttpFetcher.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/http/HttpFetcher.java Wed Sep 1 22:03:35 2010
@@ -38,4 +38,4 @@ public interface HttpFetcher {
* @throws GadgetException In the event of a failure that can't be mapped to an HTTP result code.
*/
HttpResponse fetch(HttpRequest request) throws GadgetException;
-}
\ No newline at end of file
+}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/http/HttpResponseMetadataHelper.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/http/HttpResponseMetadataHelper.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/http/HttpResponseMetadataHelper.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/http/HttpResponseMetadataHelper.java Wed Sep 1 22:03:35 2010
@@ -30,6 +30,8 @@ import java.util.logging.Logger;
/**
* Helper class to update HttpResponse metadata value.
+ *
+ * @since 2.0.0
*/
public class HttpResponseMetadataHelper {
public static final String DATA_HASH = "DataHash";
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/http/RequestPipeline.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/http/RequestPipeline.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/http/RequestPipeline.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/http/RequestPipeline.java Wed Sep 1 22:03:35 2010
@@ -35,4 +35,4 @@ public interface RequestPipeline {
* TODO: This should throw a custom exception type.
*/
HttpResponse execute(HttpRequest request) throws GadgetException;
-}
\ No newline at end of file
+}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/AccessorInfo.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/AccessorInfo.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/AccessorInfo.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/AccessorInfo.java Wed Sep 1 22:03:35 2010
@@ -21,6 +21,9 @@ import net.oauth.OAuthAccessor;
import org.apache.shindig.gadgets.oauth.OAuthStore.ConsumerInfo;
+/**
+ * OAuth related data accessor
+ */
public class AccessorInfo {
public static enum HttpMethod {
@@ -82,4 +85,4 @@ public class AccessorInfo {
public void setTokenExpireMillis(long tokenExpireMillis) {
this.tokenExpireMillis = tokenExpireMillis;
}
-}
\ No newline at end of file
+}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/BasicOAuthStoreConsumerKeyAndSecret.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/BasicOAuthStoreConsumerKeyAndSecret.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/BasicOAuthStoreConsumerKeyAndSecret.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/BasicOAuthStoreConsumerKeyAndSecret.java Wed Sep 1 22:03:35 2010
@@ -19,8 +19,7 @@
package org.apache.shindig.gadgets.oauth;
/**
- * @author beaton@google.com (Your Name Here)
- *
+ * Data structure representing and OAuth consumer key and secret
*/
public class BasicOAuthStoreConsumerKeyAndSecret {
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/BasicOAuthStoreTokenIndex.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/BasicOAuthStoreTokenIndex.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/BasicOAuthStoreTokenIndex.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/BasicOAuthStoreTokenIndex.java Wed Sep 1 22:03:35 2010
@@ -22,7 +22,7 @@ package org.apache.shindig.gadgets.oauth
import com.google.common.base.Objects;
/**
- *
+ * Simple class representing oauth token store
*/
public class BasicOAuthStoreTokenIndex {
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/GadgetOAuthCallbackGenerator.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/GadgetOAuthCallbackGenerator.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/GadgetOAuthCallbackGenerator.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/GadgetOAuthCallbackGenerator.java Wed Sep 1 22:03:35 2010
@@ -38,43 +38,43 @@ import org.apache.shindig.gadgets.uri.OA
/**
* Generates callback URLs for gadgets using OAuth 1.0a. There are three relevant callback URLs:
- *
+ *
* 1) The consumer key callback URL: registered with service providers when they issue OAuth
* consumer keys. Application authors will tell us the callback URL to send to the SP when they
- * provide us with their consumer key.
- *
+ * provide us with their consumer key.
+ *
* The SP will check that the callback URL we send them matches whatever was
* preregistered. It would be nice if they didn't do this, but enough do that we support it.
- *
+ *
* We don't control the consumer key callback URL. Gadget authors need to make sure that it
* always redirect to the shindig-deployment global callback URL.
- *
+ *
* 2) Global callback URL: a single callback URL that can be whitelisted by service providers
* and shared by all gadgets. This keeps service providers (and gadget authors) from needing
* to be aware of the complexities of which domain a particular gadget actually runs on.
- *
+ *
* The global callback URL always redirects to the gadget-domain callback URL.
- *
+ *
* 3) Gadget domain callback URL: URL on the same hostname as the gadget. This URL will pass
* the oauth_verifier token into the gadget for reuse. (It has to be on the same hostname
* so that the same-origin policy allows communication. We could use gadgets.rpc, except that
* because the authorization happens in a popup we've got no good way to do all the gadgets.rpc
* bootstrapping.)
- *
+ *
* Here's an example of what you might see happen with these URLs:
- *
+ *
* Shindig sends request token request to OAuth SP with callback URL of
* http://gadgetauthor.com/oauthcallback?cs=<blob>
- *
+ *
* User approves access. OAuth SP redirects to
* http://gadgetauthor.com/oauthcallback?cs=<blob>&oauth_verifier=<verifier>
- *
+ *
* gadgauthor.com redirects to deployment global callback URL:
* http://oauth.shindigexample.com/oauthcallback?cs=<blob>&oauth_verifier=<verifier>
- *
+ *
* The global callback URL redirects to a gadget-specific callback URL:
* http://12345.smodules.com/oauthcallback?oauth_verifier=<verifier>
- *
+ *
* The gadget-specific callback will use window.opener to find the opening gadget and hand it
* the verified callback URL.
*/
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/OAuthCallbackState.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/OAuthCallbackState.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/OAuthCallbackState.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/OAuthCallbackState.java Wed Sep 1 22:03:35 2010
@@ -26,7 +26,7 @@ import java.util.Map;
/**
* Handles state passed on the OAuth callback URL.
- *
+ *
* TODO: there's probably an abstract superclass that can be reused by OAuthClientState and this
* class.
*/
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/OAuthClientState.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/OAuthClientState.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/OAuthClientState.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/OAuthClientState.java Wed Sep 1 22:03:35 2010
@@ -25,7 +25,7 @@ import java.util.Map;
/**
* Class to handle OAuth fetcher state stored client side. The state is
- * stored as a signed, encrypted, time stamped blob.
+ * stored as a signed, encrypted, time stamped blob.
*/
public class OAuthClientState {
/**
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/OAuthRequestException.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/OAuthRequestException.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/OAuthRequestException.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/oauth/OAuthRequestException.java Wed Sep 1 22:03:35 2010
@@ -18,6 +18,10 @@ package org.apache.shindig.gadgets.oauth
import com.google.common.base.Preconditions;
+/**
+ * Thrown by OAuth request routines.
+ * @since 2.0.0
+ */
public class OAuthRequestException extends Exception {
/**
@@ -127,5 +131,4 @@ public class OAuthRequestException exten
public String toString() {
return '[' + error + ',' + errorText + ']';
}
-
}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/SocialDataTags.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/SocialDataTags.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/SocialDataTags.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/SocialDataTags.java Wed Sep 1 22:03:35 2010
@@ -39,6 +39,8 @@ import org.w3c.dom.Document;
* This class provides a helper to select all OSData or OSTemplate tags,
* irrespective whether this conversion occurred, ensuring that
* data pipelining and templating can work with any parser.
+ *
+ * @since 2.0.0
*/
public final class SocialDataTags {
private SocialDataTags() { }
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/caja/CajaCssParser.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/caja/CajaCssParser.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/caja/CajaCssParser.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/caja/CajaCssParser.java Wed Sep 1 22:03:35 2010
@@ -48,7 +48,9 @@ import java.io.StringWriter;
import java.io.Writer;
import java.util.Collections;
-/** A CSS DOM parser using Caja. */
+/**
+ * A CSS DOM parser using Caja.
+ */
public class CajaCssParser {
/**
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/caja/CajaHtmlParser.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/caja/CajaHtmlParser.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/caja/CajaHtmlParser.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/caja/CajaHtmlParser.java Wed Sep 1 22:03:35 2010
@@ -1,3 +1,4 @@
+
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/caja/CajaHtmlSerializer.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/caja/CajaHtmlSerializer.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/caja/CajaHtmlSerializer.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/parse/caja/CajaHtmlSerializer.java Wed Sep 1 22:03:35 2010
@@ -30,10 +30,12 @@ import java.io.StringWriter;
/**
* HtmlSerializer using Caja's Nodes.render(...) method under the hood.
+ *
+ * @since 2.0.0
*/
public class CajaHtmlSerializer implements HtmlSerializer {
public String serialize(Document doc) {
StringWriter sw = HtmlSerialization.createWriter(doc);
return Nodes.render(doc, new RenderContext(new Concatenator(sw, null)).asXml());
}
-}
\ No newline at end of file
+}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/CajaResponseRewriter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/CajaResponseRewriter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/CajaResponseRewriter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/CajaResponseRewriter.java Wed Sep 1 22:03:35 2010
@@ -67,6 +67,8 @@ import java.util.logging.Logger;
/**
* Rewriter that cajoles Javascript.
+ *
+ * @since 2.0.0
*/
public class CajaResponseRewriter implements ResponseRewriter {
private static final Logger LOG = Logger.getLogger(CajaResponseRewriter.class.getName());
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/GadgetRewritersProvider.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/GadgetRewritersProvider.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/GadgetRewritersProvider.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/GadgetRewritersProvider.java Wed Sep 1 22:03:35 2010
@@ -29,8 +29,9 @@ import java.util.List;
/**
* Class to provide list of rewriters according to gadget request.
- * Provide different list of rewriters fro html accelerate request
+ * Provide different list of rewriters for html accelerate request
*
+ * @since 2.0.0
*/
public class GadgetRewritersProvider {
private final List<GadgetRewriter> renderRewriters;
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/RenderModule.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/RenderModule.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/RenderModule.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/RenderModule.java Wed Sep 1 22:03:35 2010
@@ -60,4 +60,4 @@ public class RenderModule extends Abstra
"src", "start", "style", "summary", "title", "type", "usemap", "valign", "value",
"vspace", "width");
}
-}
\ No newline at end of file
+}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/SanitizingProxyUriManager.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/SanitizingProxyUriManager.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/SanitizingProxyUriManager.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/SanitizingProxyUriManager.java Wed Sep 1 22:03:35 2010
@@ -31,6 +31,8 @@ import java.util.List;
/**
* Forcible rewrite the link through the proxy and force sanitization with
* an expected mime type.
+ *
+ * @since 2.0.0
*/
public class SanitizingProxyUriManager implements ProxyUriManager {
private final ProxyUriManager wrapped;
@@ -61,4 +63,4 @@ public class SanitizingProxyUriManager i
return sanitizedUris;
}
-}
\ No newline at end of file
+}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/SanitizingResponseRewriter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/SanitizingResponseRewriter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/SanitizingResponseRewriter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/SanitizingResponseRewriter.java Wed Sep 1 22:03:35 2010
@@ -40,6 +40,8 @@ import com.google.inject.Inject;
/**
* Rewriter that sanitizes CSS and image content.
+ *
+ * @since 2.0.0
*/
public class SanitizingResponseRewriter implements ResponseRewriter {
private static final Logger LOG =