Author: rjung Date: Sat Sep 24 16:39:29 2011 New Revision: 1175196 URL: http://svn.apache.org/viewvc?rev=1175196&view=rev Log: Fine grained control of session attribute replication in clusters.
- Allow to overwrite the check for distributability of session attributes by session implementations. - New cluster manager attribute sessionAttributeFilter allows to filter which session attributes are replicated using a regular expression applied to the attribute name. Merge of r1172233-1172234,r1172236,r1175158,r1175190 from trunk respectively r1172259 and r1175194 from TC7 Modified: tomcat/tc6.0.x/trunk/ (props changed) tomcat/tc6.0.x/trunk/STATUS.txt tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/session/ClusterManagerBase.java tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/session/DeltaManager.java tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/session/DeltaSession.java tomcat/tc6.0.x/trunk/java/org/apache/catalina/session/StandardSession.java tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml tomcat/tc6.0.x/trunk/webapps/docs/config/cluster-manager.xml Propchange: tomcat/tc6.0.x/trunk/ ------------------------------------------------------------------------------ --- svn:mergeinfo (original) +++ svn:mergeinfo Sat Sep 24 16:39:29 2011 @@ -1 +1 @@ -/tomcat/trunk:601180,606992,612607,630314,640888,652744,653247,666232,673796,673820,677910,683969,683982,684001,684081,684234,684269-684270,685177,687503,687645,689402,690781,691392,691805,692748,693378,694992,695053,695311,696780,696782,698012,698227,698236,698613,699427,699634,701355,709294,709811,709816,710063,710066,710125,710205,711126,711600,712461,712467,713953,714002,718360,719119,719124,719602,719626,719628,720046,720069,721040,721286,721708,721886,723404,723738,726052,727303,728032,728768,728947,729057,729567,729569,729571,729681,729809,729815,729934,730250,730590,731651,732859,732863,734734,740675,740684,742677,742697,742714,744160,744238,746321,746384,746425,747834,747863,748344,750258,750291,750921,751286-751287,751289,751295,752323,753039,757335,757774,758249,758365,758596,758616,758664,759074,761601,762868,762929,762936-762937,763166,763183,763193,763228,763262,763298,763302,763325,763599,763611,763654,763681,763706,764985,764997,765662,768335,769979,770716,77 0809,770876,772872,776921,776924,776935,776945,777464,777466,777576,777625,778379,778523-778524,781528,781779,782145,782791,783316,783696,783724,783756,783762,783766,783863,783934,784453,784602,784614,785381,785688,785768,785859,786468,786487,786490,786496,786667,787627,787770,787985,789389,790405,791041,791184,791194,791224,791243,791326,791328,791789,792740,793372,793757,793882,793981,794082,794673,794822,795043,795152,795210,795457,795466,797168,797425,797596,797607,802727,802940,804462,804544,804734,805153,809131,809603,810916,810977,812125,812137,812432,813001,813013,813866,814180,814708,814876,815972,816252,817442,817822,819339,819361,820110,820132,820874,820954,821397,828196,828201,828210,828225,828759,830378-830379,830999,831106,831774,831785,831828,831850,831860,832214,832218,833121,833545,834047,835036,835336,836405,881396,881412,883130,883134,883146,883165,883177,883362,883565,884341,885038,885231,885241,885260,885901,885991,886019,888072,889363,889606,889716,8901 39,890265,890349-890350,890417,891185-891187,891583,892198,892341,892415,892464,892555,892812,892814,892817,892843,892887,893321,893493,894580,894586,894805,894831,895013,895045,895057,895191,895392,895703,896370,896384,897380-897381,897776,898126,898256,898468,898527,898555,898558,898718,898836,898906,899284,899348,899420,899653,899769-899770,899783,899788,899792,899916,899918-899919,899935,899949,903916,905020,905151,905722,905728,905735,907311,907513,907538,907652,907819,907825,907864,908002,908721,908754,908759,909097,909206,909212,909525,909636,909869,909875,909887,910266,910370,910442,910471,910485,910974,915226,915737,915861,916097,916141,916157,916170,917598,917633,918093,918489,918594,918684,918787,918792,918799,918803,918885,919851,919914,920025,920055,920298,920449,920596,920824,920840,921444,922010,926716,927062,927621,928482,928695,928732,928798,931709,932357,932967,935105,935983,939491,939551,940064,941356,941463,943112,944409,944416,945231,945808,945835,945841 ,946686,948057,950164,950596,950614,950851,950905,951615,953434,954435,955648,955655,956832,957130,957830,958192,960701,961948,962865,962872,962881,962900,963106,963865,963868,964614,966177-966178,966292,966692,966863,981815,988448,991837,993042,1001955,1002185,1002263,1002274,1002349,1002359,1002362,1002481,1002514,1003461,1003481,1003488,1003556,1003572,1003581,1003861,1004393,1004409,1004415,1004868-1004869,1004912,1005452,1005467,1005647,1005802,1022120,1022134,1022323,1022415,1022606,1022623,1024224,1024251,1026042,1026784,1026912,1026920,1029767,1033415,1033448,1033842,1033897,1037715,1037794,1037887,1037924,1038041,1042022,1042029,1042447,1042452,1042494,1044944,1044987,1050249,1055055,1055236,1055458,1055975,1056264,1056828,1056889,1059881,1061412,1061442,1061446,1062398,1064652,1066244,1066772,1067039,1067139,1069824,1070139,1070420,1070609,1072042,1073393,1075458,1076212,1078409,1078412,1079801,1081334,1088179,1088460,1090022,1094069,1094089,1095138,1097899,1099575 ,1099586,1099772,1099789,1100145,1100822,1101094,1101144,1124680,1130774,1133014,1137862,1137996,1138950,1138953,1140693,1141104,1141441,1142043,1142904,1143134,1143150,1148216,1148471,1152601,1156519,1164567,1167394 +/tomcat/trunk:601180,606992,612607,630314,640888,652744,653247,666232,673796,673820,677910,683969,683982,684001,684081,684234,684269-684270,685177,687503,687645,689402,690781,691392,691805,692748,693378,694992,695053,695311,696780,696782,698012,698227,698236,698613,699427,699634,701355,709294,709811,709816,710063,710066,710125,710205,711126,711600,712461,712467,713953,714002,718360,719119,719124,719602,719626,719628,720046,720069,721040,721286,721708,721886,723404,723738,726052,727303,728032,728768,728947,729057,729567,729569,729571,729681,729809,729815,729934,730250,730590,731651,732859,732863,734734,740675,740684,742677,742697,742714,744160,744238,746321,746384,746425,747834,747863,748344,750258,750291,750921,751286-751287,751289,751295,752323,753039,757335,757774,758249,758365,758596,758616,758664,759074,761601,762868,762929,762936-762937,763166,763183,763193,763228,763262,763298,763302,763325,763599,763611,763654,763681,763706,764985,764997,765662,768335,769979,770716,77 0809,770876,772872,776921,776924,776935,776945,777464,777466,777576,777625,778379,778523-778524,781528,781779,782145,782791,783316,783696,783724,783756,783762,783766,783863,783934,784453,784602,784614,785381,785688,785768,785859,786468,786487,786490,786496,786667,787627,787770,787985,789389,790405,791041,791184,791194,791224,791243,791326,791328,791789,792740,793372,793757,793882,793981,794082,794673,794822,795043,795152,795210,795457,795466,797168,797425,797596,797607,802727,802940,804462,804544,804734,805153,809131,809603,810916,810977,812125,812137,812432,813001,813013,813866,814180,814708,814876,815972,816252,817442,817822,819339,819361,820110,820132,820874,820954,821397,828196,828201,828210,828225,828759,830378-830379,830999,831106,831774,831785,831828,831850,831860,832214,832218,833121,833545,834047,835036,835336,836405,881396,881412,883130,883134,883146,883165,883177,883362,883565,884341,885038,885231,885241,885260,885901,885991,886019,888072,889363,889606,889716,8901 39,890265,890349-890350,890417,891185-891187,891583,892198,892341,892415,892464,892555,892812,892814,892817,892843,892887,893321,893493,894580,894586,894805,894831,895013,895045,895057,895191,895392,895703,896370,896384,897380-897381,897776,898126,898256,898468,898527,898555,898558,898718,898836,898906,899284,899348,899420,899653,899769-899770,899783,899788,899792,899916,899918-899919,899935,899949,903916,905020,905151,905722,905728,905735,907311,907513,907538,907652,907819,907825,907864,908002,908721,908754,908759,909097,909206,909212,909525,909636,909869,909875,909887,910266,910370,910442,910471,910485,910974,915226,915737,915861,916097,916141,916157,916170,917598,917633,918093,918489,918594,918684,918787,918792,918799,918803,918885,919851,919914,920025,920055,920298,920449,920596,920824,920840,921444,922010,926716,927062,927621,928482,928695,928732,928798,931709,932357,932967,935105,935983,939491,939551,940064,941356,941463,943112,944409,944416,945231,945808,945835,945841 ,946686,948057,950164,950596,950614,950851,950905,951615,953434,954435,955648,955655,956832,957130,957830,958192,960701,961948,962865,962872,962881,962900,963106,963865,963868,964614,966177-966178,966292,966692,966863,981815,988448,991837,993042,1001955,1002185,1002263,1002274,1002349,1002359,1002362,1002481,1002514,1003461,1003481,1003488,1003556,1003572,1003581,1003861,1004393,1004409,1004415,1004868-1004869,1004912,1005452,1005467,1005647,1005802,1022120,1022134,1022323,1022415,1022606,1022623,1024224,1024251,1026042,1026784,1026912,1026920,1029767,1033415,1033448,1033842,1033897,1037715,1037794,1037887,1037924,1038041,1042022,1042029,1042447,1042452,1042494,1044944,1044987,1050249,1055055,1055236,1055458,1055975,1056264,1056828,1056889,1059881,1061412,1061442,1061446,1062398,1064652,1066244,1066772,1067039,1067139,1069824,1070139,1070420,1070609,1072042,1073393,1075458,1076212,1078409,1078412,1079801,1081334,1088179,1088460,1090022,1094069,1094089,1095138,1097899,1099575 ,1099586,1099772,1099789,1100145,1100822,1101094,1101144,1124680,1130774,1133014,1137862,1137996,1138950,1138953,1140693,1141104,1141441,1142043,1142904,1143134,1143150,1148216,1148471,1152601,1156519,1164567,1167394,1172233-1172234,1172236,1175158,1175190 Modified: tomcat/tc6.0.x/trunk/STATUS.txt URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/STATUS.txt?rev=1175196&r1=1175195&r2=1175196&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/STATUS.txt (original) +++ tomcat/tc6.0.x/trunk/STATUS.txt Sat Sep 24 16:39:29 2011 @@ -68,19 +68,6 @@ PATCHES PROPOSED TO BACKPORT: I wonder whether ConcurrentHashMap.DEFAULT_CONCURRENCY_LEVEL which is 16 is enough. - getStuckThreadIds() returns a list of ids. It might be useful to have a similar method that returns Thread.getName() names. - -* Fine grained control of session attribute replication in clusters. - Trunk revisions: 1172233, 1172234, 1172236, 1173088, 1173090, 1173461, 1175155, 1175158 - TC 7 revisions: 1172259, 1174181, 1175159 - TC 6 patch: - http://people.apache.org/~rjung/patches/cluster-attribute-filter-tc6-v3.patch - Difference between TC 7 and TC 6: In TC 6 the feature will only be available for - DeltaManager, since Delta and BackupManager do not have ClusterManagerBase as common - base class. This was refactored in TC 7, so the feature is available for both there. - So it is a straight backport of r1172259, but instead of r1174181 copy the new attribute - in DeltaManager#cloneFromtemplate(). - +1: rjung, kfujino, kkolinko - -1: * Replace unneeded call that iterated events queue in NioEndpoint.Poller. There is no need to call size() on a liked list to check whether it is empty, Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/session/ClusterManagerBase.java URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/session/ClusterManagerBase.java?rev=1175196&r1=1175195&r2=1175196&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/session/ClusterManagerBase.java (original) +++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/session/ClusterManagerBase.java Sat Sep 24 16:39:29 2011 @@ -17,15 +17,17 @@ package org.apache.catalina.ha.session; -import org.apache.catalina.ha.ClusterManager; import java.beans.PropertyChangeListener; -import org.apache.catalina.Lifecycle; -import org.apache.catalina.session.ManagerBase; -import org.apache.catalina.Loader; import java.io.ByteArrayInputStream; import java.io.IOException; -import org.apache.catalina.tribes.io.ReplicationStream; +import java.util.regex.Pattern; + import org.apache.catalina.Container; +import org.apache.catalina.Lifecycle; +import org.apache.catalina.Loader; +import org.apache.catalina.ha.ClusterManager; +import org.apache.catalina.session.ManagerBase; +import org.apache.catalina.tribes.io.ReplicationStream; /** * @@ -36,6 +38,64 @@ import org.apache.catalina.Container; public abstract class ClusterManagerBase extends ManagerBase implements Lifecycle, PropertyChangeListener, ClusterManager{ + /** + * The pattern used for including session attributes to + * replication, e.g. <code>^(userName|sessionHistory)$</code>. + * If not set, all session attributes will be eligible for replication. + */ + private String sessionAttributeFilter = null; + + /** + * The compiled pattern used for including session attributes to + * replication, e.g. <code>^(userName|sessionHistory)$</code>. + * If not set, all session attributes will be eligible for replication. + */ + private Pattern sessionAttributePattern = null; + + + /** + * Return the string pattern used for including session attributes + * to replication. + * + * @return the sessionAttributeFilter + */ + public String getSessionAttributeFilter() { + return sessionAttributeFilter; + } + + /** + * Set the pattern used for including session attributes to replication. + * If not set, all session attributes will be eligible for replication. + * <p> + * E.g. <code>^(userName|sessionHistory)$</code> + * </p> + * + * @param sessionAttributeFilter + * the filter name pattern to set + */ + public void setSessionAttributeFilter(String sessionAttributeFilter) { + if (sessionAttributeFilter == null + || sessionAttributeFilter.trim().equals("")) { + this.sessionAttributeFilter = null; + sessionAttributePattern = null; + } else { + this.sessionAttributeFilter = sessionAttributeFilter; + sessionAttributePattern = Pattern.compile(sessionAttributeFilter); + } + } + + /** + * Check whether the given session attribute should be distributed + * + * @return true if the attribute should be distributed + */ + public boolean willAttributeDistribute(String name) { + if (sessionAttributePattern == null) { + return true; + } + return sessionAttributePattern.matcher(name).matches(); + } + public static ClassLoader[] getClassLoaders(Container container) { Loader loader = null; ClassLoader classLoader = null; @@ -72,4 +132,4 @@ public abstract class ClusterManagerBase } -} \ No newline at end of file +} Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/session/DeltaManager.java URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/session/DeltaManager.java?rev=1175196&r1=1175195&r2=1175196&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/session/DeltaManager.java (original) +++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/session/DeltaManager.java Sat Sep 24 16:39:29 2011 @@ -1695,6 +1695,7 @@ public class DeltaManager extends Cluste result.receiverQueue = receiverQueue ; result.stateTimestampDrop = stateTimestampDrop ; result.stateTransferCreateSendTime = stateTransferCreateSendTime; + result.setSessionAttributeFilter(getSessionAttributeFilter()); return result; } } Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/session/DeltaSession.java URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/session/DeltaSession.java?rev=1175196&r1=1175195&r2=1175196&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/session/DeltaSession.java (original) +++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/session/DeltaSession.java Sat Sep 24 16:39:29 2011 @@ -550,6 +550,37 @@ public class DeltaSession extends Standa /** + * Check whether the Object can be distributed. + * The object is always distributable, if the cluster manager + * decides to never distribute it. + * @param name The name of the attribute to check + * @param value The value of the attribute to check + * @return true if the attribute is distributable, false otherwise + */ + @Override + protected boolean isAttributeDistributable(String name, Object value) { + if (manager instanceof ClusterManagerBase && + !((ClusterManagerBase)manager).willAttributeDistribute(name)) + return true; + return super.isAttributeDistributable(name, value); + } + + /** + * Exclude attributes from replication. + * @param name the attribute's name + * @return true if attribute should not be replicated + */ + @Override + protected boolean exclude(String name) { + + if (super.exclude(name)) + return true; + if (manager instanceof ClusterManagerBase) + return !((ClusterManagerBase)manager).willAttributeDistribute(name); + return false; + } + + /** * Remove the object bound with the specified name from this session. If the * session does not have an object bound with this name, this method does * nothing. @@ -624,6 +655,7 @@ public class DeltaSession extends Standa // -------------------------------------------- HttpSession Private Methods + /** * Read a serialized version of this session object from the specified * object input stream. Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/session/StandardSession.java URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/session/StandardSession.java?rev=1175196&r1=1175195&r2=1175196&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/java/org/apache/catalina/session/StandardSession.java (original) +++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/session/StandardSession.java Sat Sep 24 16:39:29 2011 @@ -1347,7 +1347,7 @@ public class StandardSession throw new IllegalStateException (sm.getString("standardSession.setAttribute.ise")); if ((manager != null) && manager.getDistributable() && - !(value instanceof Serializable)) + !isAttributeDistributable(name, value)) throw new IllegalArgumentException (sm.getString("standardSession.setAttribute.iae", name)); // Construct an event with the new value @@ -1454,6 +1454,19 @@ public class StandardSession return (this.isValid || this.expiring); } + /** + * Check whether the Object can be distributed. This implementation + * simply checks for serializability. Derived classes might use other + * distribution technology not based on serialization and can extend + * this check. + * @param name The name of the attribute to check + * @param value The value of the attribute to check + * @return true if the attribute is distributable, false otherwise + */ + protected boolean isAttributeDistributable(String name, Object value) { + return value instanceof Serializable; + } + /** * Read a serialized version of this session object from the specified @@ -1590,7 +1603,7 @@ public class StandardSession /** - * Exclude attribute that cannot be serialized. + * Exclude standard attributes that cannot be serialized. * @param name the attribute's name */ protected boolean exclude(String name){ Modified: tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml?rev=1175196&r1=1175195&r2=1175196&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml (original) +++ tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml Sat Sep 24 16:39:29 2011 @@ -61,6 +61,10 @@ The digester has been changed to use the expected logger name. (kkolinko) </fix> + <add> + Allow to overwrite the check for distributability + of session attributes by session implementations. (rjung) + </add> </changelog> </subsection> <subsection name="Coyote"> @@ -98,6 +102,11 @@ <bug>51736</bug>: Make rpcTimeout configurable in BackupManager. (kfujino) </add> + <add> + New cluster manager attribute <code>sessionAttributeFilter</code> + allows to filter which session attributes are replicated using a + regular expression applied to the attribute name. (rjung) + </add> </changelog> </subsection> <subsection name="Webapps"> Modified: tomcat/tc6.0.x/trunk/webapps/docs/config/cluster-manager.xml URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/config/cluster-manager.xml?rev=1175196&r1=1175195&r2=1175196&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/webapps/docs/config/cluster-manager.xml (original) +++ tomcat/tc6.0.x/trunk/webapps/docs/config/cluster-manager.xml Sat Sep 24 16:39:29 2011 @@ -123,6 +123,15 @@ from another node when a node is starting up. Default value is <code>60</code> seconds. </attribute> + <attribute name="sessionAttributeFilter" required="false"> + A regular expression used to filter, which session attributes will + be replicated. An attribute will only be replicated, if its name + matches this pattern. If the pattern is not set (default), all + attributes are eligible for replication. As an example, the value + <code>^(userName|sessionHistory)$</code> will only replicate the two + session attributes named <code>userName</code> and + <code>sessionHistory</code>. + </attribute> </attributes> </subsection> <subsection name="org.apache.catalina.ha.session.BackupManager Attributes"> --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org