You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jspwiki.apache.org by ju...@apache.org on 2018/11/20 22:58:44 UTC
[jspwiki] 06/07: remove warnings from code, add missing @Overrides,
etc.
This is an automated email from the ASF dual-hosted git repository.
juanpablo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jspwiki.git
commit 2dd19738c4af345fb4efc4e5b52dc3ed69beeba9
Author: juanpablo <ju...@apache.org>
AuthorDate: Tue Nov 20 23:55:46 2018 +0100
remove warnings from code, add missing @Overrides, etc.
---
.../src/main/java/org/apache/wiki/WikiSession.java | 28 ++++++++++++-----
.../java/org/apache/wiki/auth/SessionMonitor.java | 11 ++++---
.../apache/wiki/auth/user/DefaultUserProfile.java | 35 +++++++++++++++++++---
.../org/apache/wiki/tags/HistoryIteratorTag.java | 29 ++++++++----------
.../java/org/apache/wiki/tags/IteratorTag.java | 16 +++++-----
.../main/java/org/apache/wiki/ui/Installer.java | 3 +-
.../org/apache/wiki/workflow/WorkflowManager.java | 7 +++--
7 files changed, 83 insertions(+), 46 deletions(-)
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/WikiSession.java b/jspwiki-main/src/main/java/org/apache/wiki/WikiSession.java
index cfee5d1..d7a11d7 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/WikiSession.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/WikiSession.java
@@ -21,7 +21,14 @@ package org.apache.wiki;
import java.security.AccessControlException;
import java.security.Principal;
import java.security.PrivilegedAction;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.LinkedHashSet;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Set;
import javax.security.auth.Subject;
import javax.servlet.http.HttpServletRequest;
@@ -29,8 +36,12 @@ import javax.servlet.http.HttpSession;
import org.apache.commons.lang.StringUtils;
import org.apache.log4j.Logger;
-
-import org.apache.wiki.auth.*;
+import org.apache.wiki.auth.AuthenticationManager;
+import org.apache.wiki.auth.GroupPrincipal;
+import org.apache.wiki.auth.NoSuchPrincipalException;
+import org.apache.wiki.auth.SessionMonitor;
+import org.apache.wiki.auth.UserManager;
+import org.apache.wiki.auth.WikiPrincipal;
import org.apache.wiki.auth.authorize.Group;
import org.apache.wiki.auth.authorize.GroupManager;
import org.apache.wiki.auth.authorize.Role;
@@ -104,11 +115,11 @@ public final class WikiSession implements WikiEventListener
private static final String ALL = "*";
- private static ThreadLocal<WikiSession> c_guestSession = new ThreadLocal<WikiSession>();
+ private static ThreadLocal<WikiSession> c_guestSession = new ThreadLocal<>();
private final Subject m_subject = new Subject();
- private final Map<String,Set<String>> m_messages = new HashMap<String,Set<String>>();
+ private final Map<String,Set<String>> m_messages = new HashMap<>();
/** The WikiEngine that created this session. */
private WikiEngine m_engine = null;
@@ -290,7 +301,7 @@ public final class WikiSession implements WikiEventListener
Set<String> messages = m_messages.get( topic );
if (messages == null )
{
- messages = new LinkedHashSet<String>();
+ messages = new LinkedHashSet<>();
m_messages.put( topic, messages );
}
messages.add( StringUtils.defaultString( message ) );
@@ -354,7 +365,7 @@ public final class WikiSession implements WikiEventListener
*/
public Principal[] getPrincipals()
{
- ArrayList<Principal> principals = new ArrayList<Principal>();
+ ArrayList<Principal> principals = new ArrayList<>();
// Take the first non Role as the main Principal
for( Principal principal : m_subject.getPrincipals() )
@@ -383,7 +394,7 @@ public final class WikiSession implements WikiEventListener
*/
public Principal[] getRoles()
{
- Set<Principal> roles = new HashSet<Principal>();
+ Set<Principal> roles = new HashSet<>();
// Add all of the Roles possessed by the Subject directly
roles.addAll( m_subject.getPrincipals( Role.class ) );
@@ -433,6 +444,7 @@ public final class WikiSession implements WikiEventListener
* by the WikiSession.
* @see org.apache.wiki.event.WikiEventListener#actionPerformed(org.apache.wiki.event.WikiEvent)
*/
+ @Override
public void actionPerformed( WikiEvent event )
{
if ( event instanceof WikiSecurityEvent )
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/auth/SessionMonitor.java b/jspwiki-main/src/main/java/org/apache/wiki/auth/SessionMonitor.java
index ce2c076..d7439ea 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/auth/SessionMonitor.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/auth/SessionMonitor.java
@@ -51,10 +51,10 @@ public class SessionMonitor implements HttpSessionListener
private static Logger log = Logger.getLogger( SessionMonitor.class );
/** Map with WikiEngines as keys, and SessionMonitors as values. */
- private static ConcurrentHashMap<WikiEngine, SessionMonitor> c_monitors = new ConcurrentHashMap<WikiEngine, SessionMonitor>();
+ private static ConcurrentHashMap<WikiEngine, SessionMonitor> c_monitors = new ConcurrentHashMap<>();
/** Weak hashmap with HttpSessions as keys, and WikiSessions as values. */
- private final Map<String, WikiSession> m_sessions = new WeakHashMap<String, WikiSession>();
+ private final Map<String, WikiSession> m_sessions = new WeakHashMap<>();
private WikiEngine m_engine;
@@ -199,7 +199,7 @@ public class SessionMonitor implements HttpSessionListener
*/
public final Principal[] userPrincipals()
{
- Collection<Principal> principals = new ArrayList<Principal>();
+ Collection<Principal> principals = new ArrayList<>();
synchronized ( m_sessions ) {
for (WikiSession session : m_sessions.values()) {
principals.add( session.getUserPrincipal() );
@@ -250,9 +250,11 @@ public class SessionMonitor implements HttpSessionListener
*
* @param se the HTTP session event
*/
+ @Override
public void sessionCreated( HttpSessionEvent se )
{
HttpSession session = se.getSession();
+ log.debug( "Created session: " + session.getId() + "." );
}
/**
@@ -260,6 +262,7 @@ public class SessionMonitor implements HttpSessionListener
* container destroys an HTTP session.
* @param se the HTTP session event
*/
+ @Override
public void sessionDestroyed( HttpSessionEvent se )
{
HttpSession session = se.getSession();
@@ -272,7 +275,7 @@ public class SessionMonitor implements HttpSessionListener
monitor.remove(session);
- log.debug("Removed session "+session.getId()+".");
+ log.debug( "Removed session " + session.getId() + "." );
if( storedSession != null )
{
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/auth/user/DefaultUserProfile.java b/jspwiki-main/src/main/java/org/apache/wiki/auth/user/DefaultUserProfile.java
index 9d426b3..e3ea12e 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/auth/user/DefaultUserProfile.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/auth/user/DefaultUserProfile.java
@@ -18,13 +18,16 @@
*/
package org.apache.wiki.auth.user;
-import org.apache.commons.lang.StringUtils;
-
import java.io.Serializable;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
+import javax.servlet.http.HttpServletRequest;
+
+import org.apache.commons.lang.StringUtils;
+import org.apache.wiki.WikiSession;
+
/**
* Default implementation for representing wiki user information, such as the
* login name, full name, wiki name, and e-mail address.
@@ -39,7 +42,7 @@ public final class DefaultUserProfile implements UserProfile
private static final String WHITESPACE = "\\s";
- private Map<String,Serializable> attributes = new HashMap<String,Serializable>();
+ private Map<String,Serializable> attributes = new HashMap<>();
private Date created = null;
@@ -81,6 +84,7 @@ public final class DefaultUserProfile implements UserProfile
/**
* {@inheritDoc}
*/
+ @Override
public boolean equals( Object o )
{
if ( ( o != null ) && ( o instanceof UserProfile ) )
@@ -94,6 +98,7 @@ public final class DefaultUserProfile implements UserProfile
return false;
}
+ @Override
public int hashCode()
{
return (fullname != null ? fullname.hashCode() : 0) ^
@@ -108,6 +113,7 @@ public final class DefaultUserProfile implements UserProfile
* @return the creation date
* @see org.apache.wiki.auth.user.UserProfile#getCreated()
*/
+ @Override
public Date getCreated()
{
return created;
@@ -117,6 +123,7 @@ public final class DefaultUserProfile implements UserProfile
* Returns the user's e-mail address.
* @return the e-mail address
*/
+ @Override
public String getEmail()
{
return email;
@@ -126,6 +133,7 @@ public final class DefaultUserProfile implements UserProfile
* Returns the user's full name.
* @return the full name
*/
+ @Override
public String getFullname()
{
return fullname;
@@ -136,6 +144,7 @@ public final class DefaultUserProfile implements UserProfile
* @return the last-modified date
* @see org.apache.wiki.auth.user.UserProfile#getLastModified()
*/
+ @Override
public Date getLastModified()
{
return modified;
@@ -145,6 +154,7 @@ public final class DefaultUserProfile implements UserProfile
* Returns the user's login name.
* @return the login name
*/
+ @Override
public String getLoginName()
{
return loginName;
@@ -159,6 +169,7 @@ public final class DefaultUserProfile implements UserProfile
* itself.
* @return the password
*/
+ @Override
public String getPassword()
{
return password;
@@ -168,6 +179,7 @@ public final class DefaultUserProfile implements UserProfile
* Returns the user's wiki name.
* @return the wiki name.
*/
+ @Override
public String getWikiName()
{
return wikiname;
@@ -180,6 +192,7 @@ public final class DefaultUserProfile implements UserProfile
* to determine the status.
* @see org.apache.wiki.auth.user.UserProfile#isNew()
*/
+ @Override
public boolean isNew()
{
return modified == null;
@@ -189,6 +202,7 @@ public final class DefaultUserProfile implements UserProfile
* @param date the creation date
* @see org.apache.wiki.auth.user.UserProfile#setCreated(java.util.Date)
*/
+ @Override
public void setCreated(Date date)
{
created = date;
@@ -198,6 +212,7 @@ public final class DefaultUserProfile implements UserProfile
* Sets the user's e-mail address.
* @param email the e-mail address
*/
+ @Override
public void setEmail( String email )
{
this.email = email;
@@ -207,6 +222,7 @@ public final class DefaultUserProfile implements UserProfile
* Sets the user's full name. For example, "Janne Jalkanen."
* @param arg the full name
*/
+ @Override
public void setFullname( String arg )
{
fullname = arg;
@@ -223,6 +239,7 @@ public final class DefaultUserProfile implements UserProfile
* @param date the last-modified date
* @see org.apache.wiki.auth.user.UserProfile#setLastModified(java.util.Date)
*/
+ @Override
public void setLastModified( Date date )
{
modified = date;
@@ -236,6 +253,7 @@ public final class DefaultUserProfile implements UserProfile
* wiki name is typically of type FirstnameLastName ("JanneJalkanen").
* @param name the login name
*/
+ @Override
public void setLoginName( String name )
{
loginName = name;
@@ -251,6 +269,7 @@ public final class DefaultUserProfile implements UserProfile
* elsewhere.
* @param arg the password
*/
+ @Override
public void setPassword( String arg )
{
password = arg;
@@ -263,7 +282,8 @@ public final class DefaultUserProfile implements UserProfile
* @param name the wiki name
* @deprecated This method will be removed in a future release.
*/
- @SuppressWarnings("deprecation")
+ @Deprecated
+ @Override
public void setWikiName( String name )
{
}
@@ -272,6 +292,7 @@ public final class DefaultUserProfile implements UserProfile
* Returns a string representation of this user profile.
* @return the string
*/
+ @Override
public String toString()
{
return "[DefaultUserProfile: '" + getFullname() + "']";
@@ -302,6 +323,7 @@ public final class DefaultUserProfile implements UserProfile
/**
* {@inheritDoc}
*/
+ @Override
public Map<String,Serializable> getAttributes()
{
return attributes;
@@ -310,6 +332,7 @@ public final class DefaultUserProfile implements UserProfile
/**
* {@inheritDoc}
*/
+ @Override
public Date getLockExpiry()
{
return isLocked() ? lockExpiry : null;
@@ -318,6 +341,7 @@ public final class DefaultUserProfile implements UserProfile
/**
* {@inheritDoc}
*/
+ @Override
public String getUid()
{
return uid;
@@ -326,6 +350,7 @@ public final class DefaultUserProfile implements UserProfile
/**
* {@inheritDoc}
*/
+ @Override
public boolean isLocked()
{
boolean locked = lockExpiry != null && System.currentTimeMillis() < lockExpiry.getTime();
@@ -341,6 +366,7 @@ public final class DefaultUserProfile implements UserProfile
/**
* {@inheritDoc}
*/
+ @Override
public void setLockExpiry( Date expiry )
{
this.lockExpiry = expiry;
@@ -349,6 +375,7 @@ public final class DefaultUserProfile implements UserProfile
/**
* {@inheritDoc}
*/
+ @Override
public void setUid( String uid )
{
this.uid = uid;
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/tags/HistoryIteratorTag.java b/jspwiki-main/src/main/java/org/apache/wiki/tags/HistoryIteratorTag.java
index f524d87..c33cd59 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/tags/HistoryIteratorTag.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/tags/HistoryIteratorTag.java
@@ -19,14 +19,14 @@
package org.apache.wiki.tags;
import java.io.IOException;
-import java.util.Collection;
+import java.util.List;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.PageContext;
import org.apache.log4j.Logger;
-import org.apache.wiki.WikiEngine;
import org.apache.wiki.WikiContext;
+import org.apache.wiki.WikiEngine;
import org.apache.wiki.WikiPage;
import org.apache.wiki.api.exceptions.ProviderException;
@@ -49,10 +49,9 @@ public class HistoryIteratorTag
static Logger log = Logger.getLogger( HistoryIteratorTag.class );
- public final int doStartTag()
- {
- m_wikiContext = (WikiContext) pageContext.getAttribute( WikiTagBase.ATTR_CONTEXT,
- PageContext.REQUEST_SCOPE );
+ @Override
+ public final int doStartTag() {
+ m_wikiContext = (WikiContext) pageContext.getAttribute( WikiTagBase.ATTR_CONTEXT, PageContext.REQUEST_SCOPE );
WikiEngine engine = m_wikiContext.getEngine();
WikiPage page;
@@ -63,7 +62,8 @@ public class HistoryIteratorTag
{
if( page != null && engine.pageExists(page) )
{
- Collection versions = engine.getVersionHistory( page.getName() );
+ @SuppressWarnings("unchecked")
+ List< WikiPage > versions = ( List< WikiPage > )engine.getVersionHistory( page.getName() );
if( versions == null )
{
@@ -77,11 +77,8 @@ public class HistoryIteratorTag
{
WikiContext context = (WikiContext)m_wikiContext.clone();
context.setPage( (WikiPage)m_iterator.next() );
- pageContext.setAttribute( WikiTagBase.ATTR_CONTEXT,
- context,
- PageContext.REQUEST_SCOPE );
- pageContext.setAttribute( getId(),
- context.getPage() );
+ pageContext.setAttribute( WikiTagBase.ATTR_CONTEXT, context, PageContext.REQUEST_SCOPE );
+ pageContext.setAttribute( getId(), context.getPage() );
}
else
{
@@ -100,6 +97,7 @@ public class HistoryIteratorTag
return SKIP_BODY;
}
+ @Override
public final int doAfterBody()
{
if( bodyContent != null )
@@ -121,11 +119,8 @@ public class HistoryIteratorTag
{
WikiContext context = (WikiContext)m_wikiContext.clone();
context.setPage( (WikiPage)m_iterator.next() );
- pageContext.setAttribute( WikiTagBase.ATTR_CONTEXT,
- context,
- PageContext.REQUEST_SCOPE );
- pageContext.setAttribute( getId(),
- context.getPage() );
+ pageContext.setAttribute( WikiTagBase.ATTR_CONTEXT, context, PageContext.REQUEST_SCOPE );
+ pageContext.setAttribute( getId(), context.getPage() );
return EVAL_BODY_BUFFERED;
}
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/tags/IteratorTag.java b/jspwiki-main/src/main/java/org/apache/wiki/tags/IteratorTag.java
index 49633f4..e04470d 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/tags/IteratorTag.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/tags/IteratorTag.java
@@ -95,6 +95,7 @@ public abstract class IteratorTag extends BodyTagSupport implements TryCatchFina
/**
* {@inheritDoc}
*/
+ @Override
public int doStartTag()
{
m_wikiContext = WikiContext.findContext(pageContext);
@@ -129,22 +130,18 @@ public abstract class IteratorTag extends BodyTagSupport implements TryCatchFina
//
// Push it to the iterator stack, and set the id.
//
- pageContext.setAttribute( WikiTagBase.ATTR_CONTEXT,
- context,
- PageContext.REQUEST_SCOPE );
- pageContext.setAttribute( getId(),
- o );
+ pageContext.setAttribute( WikiTagBase.ATTR_CONTEXT, context, PageContext.REQUEST_SCOPE );
+ pageContext.setAttribute( getId(), o );
}
/**
* {@inheritDoc}
*/
+ @Override
public int doEndTag()
{
// Return back to the original.
- pageContext.setAttribute( WikiTagBase.ATTR_CONTEXT,
- m_wikiContext,
- PageContext.REQUEST_SCOPE );
+ pageContext.setAttribute( WikiTagBase.ATTR_CONTEXT, m_wikiContext, PageContext.REQUEST_SCOPE );
return EVAL_PAGE;
}
@@ -152,6 +149,7 @@ public abstract class IteratorTag extends BodyTagSupport implements TryCatchFina
/**
* {@inheritDoc}
*/
+ @Override
public int doAfterBody()
{
if( bodyContent != null )
@@ -188,6 +186,7 @@ public abstract class IteratorTag extends BodyTagSupport implements TryCatchFina
*
* @throws Throwable I have no idea why this would throw anything
*/
+ @Override
public void doCatch(Throwable arg0) throws Throwable
{
}
@@ -198,6 +197,7 @@ public abstract class IteratorTag extends BodyTagSupport implements TryCatchFina
* if you override this method, or else some of the things may not
* work as expected.
*/
+ @Override
public void doFinally()
{
resetIterator();
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/ui/Installer.java b/jspwiki-main/src/main/java/org/apache/wiki/ui/Installer.java
index 1560868..63e7593 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/ui/Installer.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/ui/Installer.java
@@ -294,8 +294,7 @@ public class Installer
}
/**
- * Simply sanitizes any URL which contains backslashes (sometimes Windows
- * users may have them)
+ * Simply sanitizes any URL which contains backslashes (sometimes Windows users may have them)
* @param key the key of the property to sanitize
*/
private void sanitizeURL( String key )
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/workflow/WorkflowManager.java b/jspwiki-main/src/main/java/org/apache/wiki/workflow/WorkflowManager.java
index a0f4f6e..676956f 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/workflow/WorkflowManager.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/workflow/WorkflowManager.java
@@ -92,7 +92,7 @@ public class WorkflowManager implements WikiEventListener {
* @return the current workflows
*/
public Collection< Workflow > getWorkflows() {
- return new HashSet<Workflow>( m_workflows );
+ return new HashSet<>( m_workflows );
}
/**
@@ -100,7 +100,7 @@ public class WorkflowManager implements WikiEventListener {
* @return the finished workflows
*/
public List< Workflow > getCompletedWorkflows() {
- return new ArrayList< Workflow >( m_completed );
+ return new ArrayList< >( m_completed );
}
private WikiEngine m_engine = null;
@@ -247,7 +247,7 @@ public class WorkflowManager implements WikiEventListener {
*/
public Collection< Workflow > getOwnerWorkflows( WikiSession session )
{
- List<Workflow> workflows = new ArrayList<Workflow>();
+ List<Workflow> workflows = new ArrayList<>();
if ( session.isAuthenticated() )
{
Principal[] sessionPrincipals = session.getPrincipals();
@@ -277,6 +277,7 @@ public class WorkflowManager implements WikiEventListener {
* aborted or completed, it is automatically removed.
* @param event the event passed to this listener
*/
+ @Override
public void actionPerformed(WikiEvent event)
{
if (event instanceof WorkflowEvent)