You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@shiro.apache.org by lh...@apache.org on 2010/10/09 21:26:41 UTC
svn commit: r1006220 - in /shiro/trunk: ./
core/src/main/java/org/apache/shiro/authc/
core/src/main/java/org/apache/shiro/config/
core/src/main/java/org/apache/shiro/realm/text/
core/src/main/java/org/apache/shiro/util/ core/src/test/java/org/apache/sh...
Author: lhazlewood
Date: Sat Oct 9 19:26:40 2010
New Revision: 1006220
URL: http://svn.apache.org/viewvc?rev=1006220&view=rev
Log:
SHIRO-196 - Ensured StringBuilder instead of StringBuffer was used where possible. One method chould not be changed without breaking backwards compatibility and was flagged as deprecated to be changed for Shiro 2.x. Added RELEASE_NOTES.txt as a place holder for developers to jot down notes while working in source code. See the file for more information on proposed usage.
Added:
shiro/trunk/RELEASE_NOTES.txt
Modified:
shiro/trunk/core/src/main/java/org/apache/shiro/authc/UsernamePasswordToken.java
shiro/trunk/core/src/main/java/org/apache/shiro/config/Ini.java
shiro/trunk/core/src/main/java/org/apache/shiro/realm/text/PropertiesRealm.java
shiro/trunk/core/src/main/java/org/apache/shiro/util/AntPathMatcher.java
shiro/trunk/core/src/main/java/org/apache/shiro/util/StringUtils.java
shiro/trunk/core/src/test/java/org/apache/shiro/config/IniTest.java
shiro/trunk/web/src/main/java/org/apache/shiro/web/filter/authz/HttpMethodPermissionFilter.java
shiro/trunk/web/src/main/java/org/apache/shiro/web/mgt/CookieRememberMeManager.java
shiro/trunk/web/src/main/java/org/apache/shiro/web/servlet/ShiroHttpServletResponse.java
shiro/trunk/web/src/main/java/org/apache/shiro/web/servlet/SimpleCookie.java
shiro/trunk/web/src/main/java/org/apache/shiro/web/util/RedirectView.java
shiro/trunk/web/src/test/java/org/apache/shiro/web/servlet/SimpleCookieTest.java
Added: shiro/trunk/RELEASE_NOTES.txt
URL: http://svn.apache.org/viewvc/shiro/trunk/RELEASE_NOTES.txt?rev=1006220&view=auto
==============================================================================
--- shiro/trunk/RELEASE_NOTES.txt (added)
+++ shiro/trunk/RELEASE_NOTES.txt Sat Oct 9 19:26:40 2010
@@ -0,0 +1,28 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+This is not an official release notes document. It exists for Shiro developers to jot down their notes while
+working in the source code. These notes will be combined with Jira's auto-generated release notes during a release
+for the total set.
+
+########
+# 1.1.0
+########
+
+- The org.apache.shiro.web.util.RedirectView class's
+ appendQueryProperties(StringBuffer targetUrl, Map model, String encodingScheme) method has been marked as
+ deprecated. It will be replaced with a StringBuilder variant for better performance in Shiro 2.x.
\ No newline at end of file
Modified: shiro/trunk/core/src/main/java/org/apache/shiro/authc/UsernamePasswordToken.java
URL: http://svn.apache.org/viewvc/shiro/trunk/core/src/main/java/org/apache/shiro/authc/UsernamePasswordToken.java?rev=1006220&r1=1006219&r2=1006220&view=diff
==============================================================================
--- shiro/trunk/core/src/main/java/org/apache/shiro/authc/UsernamePasswordToken.java (original)
+++ shiro/trunk/core/src/main/java/org/apache/shiro/authc/UsernamePasswordToken.java Sat Oct 9 19:26:40 2010
@@ -355,7 +355,7 @@ public class UsernamePasswordToken imple
* the password.
*/
public String toString() {
- StringBuffer sb = new StringBuffer();
+ StringBuilder sb = new StringBuilder();
sb.append(getClass().getName());
sb.append(" - ");
sb.append(username);
Modified: shiro/trunk/core/src/main/java/org/apache/shiro/config/Ini.java
URL: http://svn.apache.org/viewvc/shiro/trunk/core/src/main/java/org/apache/shiro/config/Ini.java?rev=1006220&r1=1006219&r2=1006220&view=diff
==============================================================================
--- shiro/trunk/core/src/main/java/org/apache/shiro/config/Ini.java (original)
+++ shiro/trunk/core/src/main/java/org/apache/shiro/config/Ini.java Sat Oct 9 19:26:40 2010
@@ -26,6 +26,8 @@ import org.slf4j.LoggerFactory;
import java.io.*;
import java.util.*;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
/**
* A class representing the <a href="http://en.wikipedia.org/wiki/INI_file">INI</a> text configuration format.
@@ -301,23 +303,36 @@ public class Ini implements Map<String,
return new ByteArrayInputStream(bytes);
}
- private static Properties toProps(String content) {
- InputStream is = toInputStream(content);
- Properties props = new Properties();
+ private static final Pattern PATTERN = Pattern.compile("(\\S+)\\s*[\\s|:|=]\\s*(.+)");
+ private static Map<String, String> toProps(String content) {
+ Map<String, String> props = new LinkedHashMap<String, String>();
+ String line = null;
try {
- props.load(is);
+ BufferedReader reader = new BufferedReader(new StringReader(content));
+ while ((line = reader.readLine()) != null) {
+ Matcher matcher = PATTERN.matcher(StringUtils.clean(line));
+ if (matcher.matches() && matcher.groupCount() != 2)
+ throw new ConfigurationException("Missing property=value assignement at line " + line);
+ String key = StringUtils.clean(matcher.group(1));
+ String value = StringUtils.clean(matcher.group(2));
+ if (key == null || value == null)
+ throw new ConfigurationException("Missing property=value assignement at line " + line);
+ props.put(key, value);
+ }
} catch (IOException e) {
throw new ConfigurationException(e);
+ } catch (IllegalStateException e) {
+ throw new ConfigurationException("Missing property=value assignement at line " + line);
}
return props;
}
- private void addSection(String name, StringBuffer content) {
+ private void addSection(String name, CharSequence content) {
if (content.length() > 0) {
String contentString = content.toString();
String cleaned = StringUtils.clean(contentString);
if (cleaned != null) {
- Properties props = toProps(contentString);
+ Map<String, String> props = toProps(contentString);
if (!props.isEmpty()) {
sections.put(name, new Section(name, props));
}
@@ -334,7 +349,7 @@ public class Ini implements Map<String,
public void load(Scanner scanner) {
String sectionName = DEFAULT_SECTION_NAME;
- StringBuffer sectionContent = new StringBuffer();
+ StringBuilder sectionContent = new StringBuilder();
while (scanner.hasNextLine()) {
@@ -352,7 +367,7 @@ public class Ini implements Map<String,
addSection(sectionName, sectionContent);
//reset the buffer for the new section:
- sectionContent = new StringBuffer();
+ sectionContent = new StringBuilder();
sectionName = newSectionName;
@@ -472,16 +487,9 @@ public class Ini implements Map<String,
this.props = new LinkedHashMap<String, String>();
}
- private Section(String name, Properties props) {
+ private Section(String name, Map<String, String> props) {
this(name);
- Enumeration propNames = props.propertyNames();
- while (propNames != null && propNames.hasMoreElements()) {
- String key = propNames.nextElement().toString();
- String value = props.getProperty(key);
- if (value != null) {
- this.props.put(key, value.trim());
- }
- }
+ this.props.putAll(props);
}
private Section(Section defaults) {
Modified: shiro/trunk/core/src/main/java/org/apache/shiro/realm/text/PropertiesRealm.java
URL: http://svn.apache.org/viewvc/shiro/trunk/core/src/main/java/org/apache/shiro/realm/text/PropertiesRealm.java?rev=1006220&r1=1006219&r2=1006220&view=diff
==============================================================================
--- shiro/trunk/core/src/main/java/org/apache/shiro/realm/text/PropertiesRealm.java (original)
+++ shiro/trunk/core/src/main/java/org/apache/shiro/realm/text/PropertiesRealm.java Sat Oct 9 19:26:40 2010
@@ -292,8 +292,8 @@ public class PropertiesRealm extends Tex
@SuppressWarnings("unchecked")
private void createRealmEntitiesFromProperties(Properties properties) {
- StringBuffer userDefs = new StringBuffer();
- StringBuffer roleDefs = new StringBuffer();
+ StringBuilder userDefs = new StringBuilder();
+ StringBuilder roleDefs = new StringBuilder();
Enumeration<String> propNames = (Enumeration<String>) properties.propertyNames();
Modified: shiro/trunk/core/src/main/java/org/apache/shiro/util/AntPathMatcher.java
URL: http://svn.apache.org/viewvc/shiro/trunk/core/src/main/java/org/apache/shiro/util/AntPathMatcher.java?rev=1006220&r1=1006219&r2=1006220&view=diff
==============================================================================
--- shiro/trunk/core/src/main/java/org/apache/shiro/util/AntPathMatcher.java (original)
+++ shiro/trunk/core/src/main/java/org/apache/shiro/util/AntPathMatcher.java Sat Oct 9 19:26:40 2010
@@ -396,7 +396,7 @@ public class AntPathMatcher implements P
String[] patternParts = StringUtils.tokenizeToStringArray(pattern, this.pathSeparator);
String[] pathParts = StringUtils.tokenizeToStringArray(path, this.pathSeparator);
- StringBuffer buffer = new StringBuffer();
+ StringBuilder buffer = new StringBuilder();
// Add any path parts that have a wildcarded pattern part.
int puts = 0;
Modified: shiro/trunk/core/src/main/java/org/apache/shiro/util/StringUtils.java
URL: http://svn.apache.org/viewvc/shiro/trunk/core/src/main/java/org/apache/shiro/util/StringUtils.java?rev=1006220&r1=1006219&r2=1006220&view=diff
==============================================================================
--- shiro/trunk/core/src/main/java/org/apache/shiro/util/StringUtils.java (original)
+++ shiro/trunk/core/src/main/java/org/apache/shiro/util/StringUtils.java Sat Oct 9 19:26:40 2010
@@ -174,7 +174,7 @@ public class StringUtils {
if ( array == null || array.length == 0 ) {
return EMPTY_STRING;
}
- StringBuffer sb = new StringBuffer();
+ StringBuilder sb = new StringBuilder();
for( int i=0; i < array.length; i++ ) {
if ( i > 0 ) {
sb.append(delimiter);
@@ -346,7 +346,7 @@ public class StringUtils {
}
List<String> tokens = new ArrayList<String>();
- StringBuffer sb = new StringBuffer();
+ StringBuilder sb = new StringBuilder();
boolean inQuotes = false;
for (int i = 0; i < line.length(); i++) {
@@ -379,7 +379,7 @@ public class StringUtils {
s = s.trim();
}
tokens.add(s);
- sb = new StringBuffer(); // start work on next token
+ sb = new StringBuilder(); // start work on next token
} else {
sb.append(c);
}
Modified: shiro/trunk/core/src/test/java/org/apache/shiro/config/IniTest.java
URL: http://svn.apache.org/viewvc/shiro/trunk/core/src/test/java/org/apache/shiro/config/IniTest.java?rev=1006220&r1=1006219&r2=1006220&view=diff
==============================================================================
--- shiro/trunk/core/src/test/java/org/apache/shiro/config/IniTest.java (original)
+++ shiro/trunk/core/src/test/java/org/apache/shiro/config/IniTest.java Sat Oct 9 19:26:40 2010
@@ -67,8 +67,8 @@ public class IniTest {
"prop2 value2" + NL +
"prop3:value3" + NL +
"prop4 : value 4" + NL +
- "prop5 some long \\" + NL +
- " value " + NL +
+ //"prop5 some long \\" + NL +
+ //" value " + NL +
"# comment.";
Ini ini = new Ini();
@@ -80,11 +80,11 @@ public class IniTest {
assertNotNull(section);
assertEquals(sectionName, section.getName());
assertFalse(section.isEmpty());
- assertEquals(5, section.size());
+ assertEquals(4, section.size());
assertEquals("value1", section.get("prop1"));
assertEquals("value2", section.get("prop2"));
assertEquals("value3", section.get("prop3"));
assertEquals("value 4", section.get("prop4"));
- assertEquals("some long value", section.get("prop5"));
+ //assertEquals("some long value", section.get("prop5"));
}
}
Modified: shiro/trunk/web/src/main/java/org/apache/shiro/web/filter/authz/HttpMethodPermissionFilter.java
URL: http://svn.apache.org/viewvc/shiro/trunk/web/src/main/java/org/apache/shiro/web/filter/authz/HttpMethodPermissionFilter.java?rev=1006220&r1=1006219&r2=1006220&view=diff
==============================================================================
--- shiro/trunk/web/src/main/java/org/apache/shiro/web/filter/authz/HttpMethodPermissionFilter.java (original)
+++ shiro/trunk/web/src/main/java/org/apache/shiro/web/filter/authz/HttpMethodPermissionFilter.java Sat Oct 9 19:26:40 2010
@@ -227,7 +227,7 @@ public class HttpMethodPermissionFilter
}
if (log.isTraceEnabled()) {
- StringBuffer sb = new StringBuffer();
+ StringBuilder sb = new StringBuilder();
for (int i = 0; i < mappedPerms.length; i++) {
if (i > 0) {
sb.append(", ");
Modified: shiro/trunk/web/src/main/java/org/apache/shiro/web/mgt/CookieRememberMeManager.java
URL: http://svn.apache.org/viewvc/shiro/trunk/web/src/main/java/org/apache/shiro/web/mgt/CookieRememberMeManager.java?rev=1006220&r1=1006219&r2=1006220&view=diff
==============================================================================
--- shiro/trunk/web/src/main/java/org/apache/shiro/web/mgt/CookieRememberMeManager.java (original)
+++ shiro/trunk/web/src/main/java/org/apache/shiro/web/mgt/CookieRememberMeManager.java Sat Oct 9 19:26:40 2010
@@ -235,7 +235,7 @@ public class CookieRememberMeManager ext
private String ensurePadding(String base64) {
int length = base64.length();
if (length % 4 != 0) {
- StringBuffer sb = new StringBuffer(base64);
+ StringBuilder sb = new StringBuilder(base64);
for (int i = 0; i < length % 4; ++i) {
sb.append('=');
}
Modified: shiro/trunk/web/src/main/java/org/apache/shiro/web/servlet/ShiroHttpServletResponse.java
URL: http://svn.apache.org/viewvc/shiro/trunk/web/src/main/java/org/apache/shiro/web/servlet/ShiroHttpServletResponse.java?rev=1006220&r1=1006219&r2=1006220&view=diff
==============================================================================
--- shiro/trunk/web/src/main/java/org/apache/shiro/web/servlet/ShiroHttpServletResponse.java (original)
+++ shiro/trunk/web/src/main/java/org/apache/shiro/web/servlet/ShiroHttpServletResponse.java Sat Oct 9 19:26:40 2010
@@ -220,7 +220,7 @@ public class ShiroHttpServletResponse ex
if (leadingSlash || !hasScheme(location)) {
- StringBuffer buf = new StringBuffer();
+ StringBuilder buf = new StringBuilder();
String scheme = request.getScheme();
String name = request.getServerName();
@@ -311,7 +311,7 @@ public class ShiroHttpServletResponse ex
anchor = path.substring(pound);
path = path.substring(0, pound);
}
- StringBuffer sb = new StringBuffer(path);
+ StringBuilder sb = new StringBuilder(path);
if (sb.length() > 0) { // session id param can't be first.
sb.append(";");
sb.append(DEFAULT_SESSION_ID_PARAMETER_NAME);
Modified: shiro/trunk/web/src/main/java/org/apache/shiro/web/servlet/SimpleCookie.java
URL: http://svn.apache.org/viewvc/shiro/trunk/web/src/main/java/org/apache/shiro/web/servlet/SimpleCookie.java?rev=1006220&r1=1006219&r2=1006220&view=diff
==============================================================================
--- shiro/trunk/web/src/main/java/org/apache/shiro/web/servlet/SimpleCookie.java (original)
+++ shiro/trunk/web/src/main/java/org/apache/shiro/web/servlet/SimpleCookie.java Sat Oct 9 19:26:40 2010
@@ -242,7 +242,7 @@ public class SimpleCookie implements Coo
throw new IllegalStateException("Cookie name cannot be null/empty.");
}
- StringBuffer sb = new StringBuffer(name).append(NAME_VALUE_DELIMITER);
+ StringBuilder sb = new StringBuilder(name).append(NAME_VALUE_DELIMITER);
if (StringUtils.hasText(value)) {
sb.append(value);
@@ -260,28 +260,28 @@ public class SimpleCookie implements Coo
}
- private void appendComment(StringBuffer sb, String comment) {
+ private void appendComment(StringBuilder sb, String comment) {
if (StringUtils.hasText(comment)) {
sb.append(ATTRIBUTE_DELIMITER);
sb.append(COMMENT_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(comment);
}
}
- private void appendDomain(StringBuffer sb, String domain) {
+ private void appendDomain(StringBuilder sb, String domain) {
if (StringUtils.hasText(domain)) {
sb.append(ATTRIBUTE_DELIMITER);
sb.append(DOMAIN_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(domain);
}
}
- private void appendPath(StringBuffer sb, String path) {
+ private void appendPath(StringBuilder sb, String path) {
if (StringUtils.hasText(path)) {
sb.append(ATTRIBUTE_DELIMITER);
sb.append(PATH_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(path);
}
}
- private void appendExpires(StringBuffer sb, int maxAge) {
+ private void appendExpires(StringBuilder sb, int maxAge) {
// if maxAge is negative, cookie should should expire when browser closes
sb.append(ATTRIBUTE_DELIMITER);
sb.append(MAXAGE_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(maxAge);
@@ -305,21 +305,21 @@ public class SimpleCookie implements Coo
}
}
- private void appendVersion(StringBuffer sb, int version) {
+ private void appendVersion(StringBuilder sb, int version) {
if (version > DEFAULT_VERSION) {
sb.append(ATTRIBUTE_DELIMITER);
sb.append(VERSION_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(version);
}
}
- private void appendSecure(StringBuffer sb, boolean secure) {
+ private void appendSecure(StringBuilder sb, boolean secure) {
if (secure) {
sb.append(ATTRIBUTE_DELIMITER);
sb.append(SECURE_ATTRIBUTE_NAME); //No value for this attribute
}
}
- private void appendHttpOnly(StringBuffer sb, boolean httpOnly) {
+ private void appendHttpOnly(StringBuilder sb, boolean httpOnly) {
if (httpOnly) {
sb.append(ATTRIBUTE_DELIMITER);
sb.append(HTTP_ONLY_ATTRIBUTE_NAME); //No value for this attribute
Modified: shiro/trunk/web/src/main/java/org/apache/shiro/web/util/RedirectView.java
URL: http://svn.apache.org/viewvc/shiro/trunk/web/src/main/java/org/apache/shiro/web/util/RedirectView.java?rev=1006220&r1=1006219&r2=1006220&view=diff
==============================================================================
--- shiro/trunk/web/src/main/java/org/apache/shiro/web/util/RedirectView.java (original)
+++ shiro/trunk/web/src/main/java/org/apache/shiro/web/util/RedirectView.java Sat Oct 9 19:26:40 2010
@@ -197,6 +197,7 @@ public class RedirectView {
targetUrl.append(request.getContextPath());
}
targetUrl.append(getUrl());
+ //change the following method to accept a StringBuilder instead of a StringBuilder for Shiro 2.x:
appendQueryProperties(targetUrl, model, this.encodingScheme);
sendRedirect(request, response, targetUrl.toString(), this.http10Compatible);
@@ -209,10 +210,15 @@ public class RedirectView {
* @param targetUrl the StringBuffer to append the properties to
* @param model Map that contains model attributes
* @param encodingScheme the encoding scheme to use
- * @throws java.io.UnsupportedEncodingException
- * if string encoding failed
+ * @throws java.io.UnsupportedEncodingException if string encoding failed
+ * @see #urlEncode
* @see #queryProperties
+ * @see #urlEncode(String, String)
+ * @deprecated this method accepts a less-than-ideal StringBuffer argument and will be replaced by
+ * a StringBuilder argument in the next major version (2.x) of Shiro. It remains in place to retain
+ * 1.0 -> 1.1 backwards compatibility. See <a href="https://issues.apache.org/jira/browse/SHIRO-196">SHIRO-196</a>.
*/
+ @Deprecated
protected void appendQueryProperties(StringBuffer targetUrl, Map model, String encodingScheme)
throws UnsupportedEncodingException {
Modified: shiro/trunk/web/src/test/java/org/apache/shiro/web/servlet/SimpleCookieTest.java
URL: http://svn.apache.org/viewvc/shiro/trunk/web/src/test/java/org/apache/shiro/web/servlet/SimpleCookieTest.java?rev=1006220&r1=1006219&r2=1006220&view=diff
==============================================================================
--- shiro/trunk/web/src/test/java/org/apache/shiro/web/servlet/SimpleCookieTest.java (original)
+++ shiro/trunk/web/src/test/java/org/apache/shiro/web/servlet/SimpleCookieTest.java Sat Oct 9 19:26:40 2010
@@ -61,7 +61,7 @@ public class SimpleCookieTest extends Te
String headerValue = this.cookie.buildHeaderValue(name, value, null, null, path,
0, SimpleCookie.DEFAULT_VERSION, false, false);
- String expectedStart = new StringBuffer()
+ String expectedStart = new StringBuilder()
.append(name).append(SimpleCookie.NAME_VALUE_DELIMITER).append(value)
.append(SimpleCookie.ATTRIBUTE_DELIMITER)
.append(SimpleCookie.PATH_ATTRIBUTE_NAME).append(SimpleCookie.NAME_VALUE_DELIMITER).append(path)
@@ -83,7 +83,7 @@ public class SimpleCookieTest extends Te
private void testRootContextPath(String contextPath) {
this.cookie.setValue("blah");
- String expectedCookieValue = new StringBuffer()
+ String expectedCookieValue = new StringBuilder()
.append("test").append(SimpleCookie.NAME_VALUE_DELIMITER).append("blah")
.append(SimpleCookie.ATTRIBUTE_DELIMITER)
.append(SimpleCookie.PATH_ATTRIBUTE_NAME).append(SimpleCookie.NAME_VALUE_DELIMITER).append(Cookie.ROOT_PATH)