You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by fs...@apache.org on 2016/03/05 21:43:55 UTC
svn commit: r1733760 [1/2] - in /tomcat/tc8.0.x/trunk: ./
java/org/apache/catalina/mbeans/ java/org/apache/catalina/realm/
java/org/apache/catalina/security/
Author: fschumacher
Date: Sat Mar 5 20:43:54 2016
New Revision: 1733760
URL: http://svn.apache.org/viewvc?rev=1733760&view=rev
Log:
Javadoc fixes.
Merge r1724232 from /tomcat/trunk
Modified:
tomcat/tc8.0.x/trunk/ (props changed)
tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/ContainerMBean.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/ContextMBean.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/GroupMBean.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MBeanDumper.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MBeanFactory.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MBeanUtils.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MemoryUserDatabaseMBean.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/NamingResourcesMBean.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/ServiceMBean.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/UserMBean.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/CombinedRealm.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/DataSourceRealm.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/DigestCredentialHandlerBase.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/JAASRealm.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/JDBCRealm.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/JNDIRealm.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/MemoryRealm.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/RealmBase.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/UserDatabaseRealm.java
tomcat/tc8.0.x/trunk/java/org/apache/catalina/security/SecurityUtil.java
Propchange: tomcat/tc8.0.x/trunk/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Sat Mar 5 20:43:54 2016
@@ -1 +1 @@
-/tomcat/trunk:1636524,1637156,1637176,1637188,1637331,1637684,1637695,1637890,1637892,1638720-1638725,1639653,1640010,1640083-1640084,1640088,1640275,1640322,1640347,1640361,1640365,1640403,1640410,1640652,1640655-1640658,1640688,1640700-1640883,1640903,1640976,1640978,1641000,1641026,1641038-1641039,1641051-1641052,1641058,1641064,1641300,1641369,1641374,1641380,1641486,1641634,1641656-1641692,1641704,1641707-1641718,1641720-1641722,1641735,1641981,1642233,1642280,1642554,1642564,1642595,1642606,1642668,1642679,1642697,1642699,1642766,1643002,1643045,1643054-1643055,1643066,1643121,1643128,1643206,1643209-1643210,1643216,1643249,1643270,1643283,1643309-1643310,1643323,1643365-1643366,1643370-1643371,1643465,1643474,1643536,1643570,1643634,1643649,1643651,1643654,1643675,1643731,1643733-1643734,1643761,1643766,1643814,1643937,1643963,1644017,1644169,1644201-1644203,1644321,1644323,1644516,1644523,1644529,1644535,1644730,1644768,1644784-1644785,1644790,1644793,1644815,1644884,1644886
,1644890,1644892,1644910,1644924,1644929-1644930,1644935,1644989,1645011,1645247,1645355,1645357-1645358,1645455,1645465,1645469,1645471,1645473,1645475,1645486-1645488,1645626,1645641,1645685,1645743,1645763,1645951-1645953,1645955,1645993,1646098-1646106,1646178,1646220,1646302,1646304,1646420,1646470-1646471,1646476,1646559,1646717-1646723,1646773,1647026,1647042,1647530,1647655,1648304,1648815,1648907,1649973,1650081,1650365,1651116,1651120,1651280,1651470,1652938,1652970,1653041,1653471,1653550,1653574,1653797,1653815-1653816,1653819,1653840,1653857,1653888,1653972,1654013,1654030,1654050,1654123,1654148,1654159,1654513,1654515,1654517,1654522,1654524,1654725,1654735,1654766,1654785,1654851-1654852,1654978,1655122-1655124,1655126-1655127,1655129-1655130,1655132-1655133,1655312,1655351,1655438,1655441,1655454,1655558,1656087,1656299,1656319,1656331,1656345,1656350,1656590,1656648-1656650,1656657,1657041,1657054,1657374,1657492,1657510,1657565,1657580,1657584,1657586,1657589,1657
592,1657607,1657609,1657682,1657907,1658207,1658734,1658781,1658790,1658799,1658802,1658804,1658833,1658840,1658966,1659043,1659053,1659059,1659174,1659184,1659188-1659189,1659216,1659263,1659293,1659304,1659306-1659307,1659382,1659384,1659428,1659471,1659486,1659505,1659516,1659521,1659524,1659559,1659562,1659803,1659806,1659814,1659833,1659862,1659905,1659919,1659948,1659967,1659983-1659984,1660060,1660074,1660077,1660133,1660168,1660331-1660332,1660353,1660358,1660924,1661386,1661770,1661867,1661972,1661990,1662200,1662308-1662309,1662548,1662614,1662696,1662736,1662985,1662988-1662989,1663264,1663277,1663298,1663534,1663562,1663676,1663715,1663754,1663768,1663772,1663781,1663893,1663995,1664143,1664163,1664174,1664301,1664317,1664347,1664657,1664659,1664710,1664863-1664864,1664866,1665085,1665292,1665559,1665653,1665661,1665672,1665694,1665697,1665736,1665779,1665976-1665977,1665980-1665981,1665985-1665986,1665989,1665998,1666004,1666008,1666013,1666017,1666024,1666116,1666386-1
666387,1666494,1666496,1666552,1666569,1666579,1666637,1666649,1666757,1666966,1666972,1666985,1666995,1666997,1667292,1667402,1667406,1667546,1667615,1667630,1667636,1667688,1667764,1667871,1668026,1668135,1668193,1668593,1668596,1668630,1668639,1668843,1669353,1669370,1669451,1669800,1669838,1669876,1669882,1670394,1670433,1670591,1670598-1670600,1670610,1670631,1670719,1670724,1670726,1670730,1670940,1671112,1672272,1672284,1673754,1674294,1675461,1675486,1675594,1675830,1676231,1676250-1676251,1676364,1676381,1676393,1676479,1676525,1676552,1676615,1676630,1676634,1676721,1676926,1676943,1677140,1677802,1678011,1678162,1678174,1678339,1678426-1678427,1678694,1678701,1679534,1679708,1679710,1679716,1680034,1680246,1681056,1681123,1681138,1681280,1681283,1681286,1681450,1681697,1681699,1681701,1681729,1681770,1681779,1681793,1681807,1681837-1681838,1681854,1681862,1681958,1682028,1682033,1682311,1682315,1682317,1682320,1682324,1682330,1682842,1684172,1684366,1684383,1684526-168452
7,1684549-1684550,1685556,1685591,1685739,1685744,1685772,1685816,1685826,1685891,1687242,1687261,1687268,1687340,1687551,1688563,1688841,1688878,1688885,1688896,1688901,1689345-1689346,1689357,1689656,1689675-1689677,1689679,1689687,1689825,1689856,1689918,1690011,1690021,1690054,1690080,1690209,1691134,1691487,1691813,1692744-1692747,1692849,1692894,1692896,1693088,1693105,1693429,1693461,1694058,1694111,1694290,1694501,1694548,1694658,1694660,1694788,1694872,1694878,1695006,1695354,1695371,1695379,1695459,1695582,1695706,1695778,1696199,1696272,1696280,1696366-1696368,1696378,1696390,1696392,1696467,1698212,1698220,1700607,1700870,1700896,1700977,1701093,1701123,1701213,1701607,1701666,1701673,1701760-1701761,1701765,1701940,1702092,1702183,1702244,1702246,1702250,1702268,1702313,1702531,1702630-1702635,1702637-1702638,1702640,1702647,1702660,1702662,1702665-1702666,1702668,1702671-1702673,1702675-1702676,1702680,1702722,1702778,1702795,1702862,1702881,1702886,1702910,1702923,170
2971,1702984,1703024,1703040,1703044,1703049-1703050,1703143,1703146,1703151,1703160,1703164,1703167,1703174,1703192,1703287,1703290,1703358,1703408,1703486,1703509,1703523,1703542,1703545,1703554,1703584,1703673,1703676,1703678,1703680,1703763,1703784,1703821,1703842,1703849,1703851,1703853,1703856,1703860,1703865,1703890,1703948,1704149,1704151,1704251,1704278,1704289,1704302,1704305,1704307,1704318,1704331,1704647,1704658,1704689,1704702,1704706,1704711,1704730-1704733,1704735,1704739,1704741-1704742,1704744,1704786,1704867,1705231,1705630,1705635,1705639,1705647,1705650-1705652,1705842,1705848,1705865-1705866,1705942,1706017,1706744-1706745,1706853,1706915,1707052,1707088,1708500-1708501,1708504-1708505,1708570,1708649,1708687,1708745,1708957,1709120,1709266,1709295,1709375,1709663,1709895,1709960,1710070,1710134,1710341,1710346,1710441,1710445,1710489,1710517,1710523,1710571,1710577,1710632,1710676,1710689,1710753-1710754,1710779,1710924,1710930,1710933,1710945,1711006,1711016,
1711022,1711026,1712163,1712225,1712228,1712233,1712250,1712254,1712489,1712547-1712548,1712588,1712617,1712645,1712654,1712695,1712765-1712766,1712771,1712775,1712859,1712876,1712898,1712902,1712905,1712912,1712974,1713129,1713168,1713184,1713285,1713362,1713397,1713446,1713612,1713618,1713871,1713931,1713975,1713987,1713992,1713997,1714002,1714012,1714019,1714054,1714521,1714535,1714537,1715168,1715188,1715206,1715413,1715415,1715510-1715512,1715514-1715515,1715517-1715519,1715521,1715633,1715661,1715682,1715965,1716213-1716214,1716258,1716269,1716347,1716354,1716364,1716413,1716420,1716511,1716543,1716640,1716644,1716856,1716858,1716881-1716882,1716886,1716894,1717085,1717225,1717233,1717252,1717264,1717282,1717286,1717290,1717385,1717416,1717418,1717445,1717515,1717520,1717528,1717965,1717967-1717968,1717979,1718022,1718308,1718523,1718794,1718796,1718834,1718836-1718838,1719278,1719291,1719315,1719332,1719334,1719340,1719346,1719441,1719446,1719488,1719909-1719910,1720200,17202
34,1720394,1720439,1720445,1720448,1720462,1720506,1720652,1720654-1720655,1720711,1720752,1720769,1720776,1720804,1720815,1721303,1721307,1721311,1721314,1721447,1721528,1721539,1721812,1721817,1721830,1721860,1721866,1721881,1721887,1722205,1722292,1722399,1722453,1722455,1722522,1722526,1722532,1722548,1722574,1722583,1722585,1722799,1722807,1722824,1722828-1722829,1722831,1722859,1722902,1722905,1722923,1722939,1722945,1722996,1723068,1723127,1723155,1723250,1723316-1723318,1723368,1723371,1723375,1723377,1723380,1723410,1723414,1723437,1723484,1723486,1723493-1723494,1723500,1723552,1723554,1723683,1723707,1723736,1724012,1724252,1724325,1724427-1724428,1724433,1724673,1724788,1724863,1724900,1724997,1725113,1725126-1725127,1725150,1725165,1725183,1725199,1725202,1725204,1725207,1725263-1725264,1725266,1725278,1725282,1725405,1725599,1725601,1725635,1725646,1725649-1725652,1725694,1725696-1725697,1725816,1725851,1725906-1725907,1725910,1725914,1725920,1725926,1726177,1726202,17
26628,1726632,1726637,1726639,1726648,1726651,1726654,1726669,1726676,1726803,1726925-1726926,1726972-1726973,1726991,1727162,1727670,1727675,1727899,1727914,1727917,1728091,1728138,1728433,1728448,1729185,1729361,1729625,1729730,1730101-1730102,1730137,1730612,1730946,1730952,1730975,1731008,1731055,1731079,1731283,1731856,1731882,1731946,1731953,1731958,1731976,1731982-1731983,1732359,1732488,1732900,1733019,1733041,1733044,1733077,1733080,1733093,1733154,1733247,1733448,1733602,1733617,1733734,1733751
+/tomcat/trunk:1636524,1637156,1637176,1637188,1637331,1637684,1637695,1637890,1637892,1638720-1638725,1639653,1640010,1640083-1640084,1640088,1640275,1640322,1640347,1640361,1640365,1640403,1640410,1640652,1640655-1640658,1640688,1640700-1640883,1640903,1640976,1640978,1641000,1641026,1641038-1641039,1641051-1641052,1641058,1641064,1641300,1641369,1641374,1641380,1641486,1641634,1641656-1641692,1641704,1641707-1641718,1641720-1641722,1641735,1641981,1642233,1642280,1642554,1642564,1642595,1642606,1642668,1642679,1642697,1642699,1642766,1643002,1643045,1643054-1643055,1643066,1643121,1643128,1643206,1643209-1643210,1643216,1643249,1643270,1643283,1643309-1643310,1643323,1643365-1643366,1643370-1643371,1643465,1643474,1643536,1643570,1643634,1643649,1643651,1643654,1643675,1643731,1643733-1643734,1643761,1643766,1643814,1643937,1643963,1644017,1644169,1644201-1644203,1644321,1644323,1644516,1644523,1644529,1644535,1644730,1644768,1644784-1644785,1644790,1644793,1644815,1644884,1644886
,1644890,1644892,1644910,1644924,1644929-1644930,1644935,1644989,1645011,1645247,1645355,1645357-1645358,1645455,1645465,1645469,1645471,1645473,1645475,1645486-1645488,1645626,1645641,1645685,1645743,1645763,1645951-1645953,1645955,1645993,1646098-1646106,1646178,1646220,1646302,1646304,1646420,1646470-1646471,1646476,1646559,1646717-1646723,1646773,1647026,1647042,1647530,1647655,1648304,1648815,1648907,1649973,1650081,1650365,1651116,1651120,1651280,1651470,1652938,1652970,1653041,1653471,1653550,1653574,1653797,1653815-1653816,1653819,1653840,1653857,1653888,1653972,1654013,1654030,1654050,1654123,1654148,1654159,1654513,1654515,1654517,1654522,1654524,1654725,1654735,1654766,1654785,1654851-1654852,1654978,1655122-1655124,1655126-1655127,1655129-1655130,1655132-1655133,1655312,1655351,1655438,1655441,1655454,1655558,1656087,1656299,1656319,1656331,1656345,1656350,1656590,1656648-1656650,1656657,1657041,1657054,1657374,1657492,1657510,1657565,1657580,1657584,1657586,1657589,1657
592,1657607,1657609,1657682,1657907,1658207,1658734,1658781,1658790,1658799,1658802,1658804,1658833,1658840,1658966,1659043,1659053,1659059,1659174,1659184,1659188-1659189,1659216,1659263,1659293,1659304,1659306-1659307,1659382,1659384,1659428,1659471,1659486,1659505,1659516,1659521,1659524,1659559,1659562,1659803,1659806,1659814,1659833,1659862,1659905,1659919,1659948,1659967,1659983-1659984,1660060,1660074,1660077,1660133,1660168,1660331-1660332,1660353,1660358,1660924,1661386,1661770,1661867,1661972,1661990,1662200,1662308-1662309,1662548,1662614,1662696,1662736,1662985,1662988-1662989,1663264,1663277,1663298,1663534,1663562,1663676,1663715,1663754,1663768,1663772,1663781,1663893,1663995,1664143,1664163,1664174,1664301,1664317,1664347,1664657,1664659,1664710,1664863-1664864,1664866,1665085,1665292,1665559,1665653,1665661,1665672,1665694,1665697,1665736,1665779,1665976-1665977,1665980-1665981,1665985-1665986,1665989,1665998,1666004,1666008,1666013,1666017,1666024,1666116,1666386-1
666387,1666494,1666496,1666552,1666569,1666579,1666637,1666649,1666757,1666966,1666972,1666985,1666995,1666997,1667292,1667402,1667406,1667546,1667615,1667630,1667636,1667688,1667764,1667871,1668026,1668135,1668193,1668593,1668596,1668630,1668639,1668843,1669353,1669370,1669451,1669800,1669838,1669876,1669882,1670394,1670433,1670591,1670598-1670600,1670610,1670631,1670719,1670724,1670726,1670730,1670940,1671112,1672272,1672284,1673754,1674294,1675461,1675486,1675594,1675830,1676231,1676250-1676251,1676364,1676381,1676393,1676479,1676525,1676552,1676615,1676630,1676634,1676721,1676926,1676943,1677140,1677802,1678011,1678162,1678174,1678339,1678426-1678427,1678694,1678701,1679534,1679708,1679710,1679716,1680034,1680246,1681056,1681123,1681138,1681280,1681283,1681286,1681450,1681697,1681699,1681701,1681729,1681770,1681779,1681793,1681807,1681837-1681838,1681854,1681862,1681958,1682028,1682033,1682311,1682315,1682317,1682320,1682324,1682330,1682842,1684172,1684366,1684383,1684526-168452
7,1684549-1684550,1685556,1685591,1685739,1685744,1685772,1685816,1685826,1685891,1687242,1687261,1687268,1687340,1687551,1688563,1688841,1688878,1688885,1688896,1688901,1689345-1689346,1689357,1689656,1689675-1689677,1689679,1689687,1689825,1689856,1689918,1690011,1690021,1690054,1690080,1690209,1691134,1691487,1691813,1692744-1692747,1692849,1692894,1692896,1693088,1693105,1693429,1693461,1694058,1694111,1694290,1694501,1694548,1694658,1694660,1694788,1694872,1694878,1695006,1695354,1695371,1695379,1695459,1695582,1695706,1695778,1696199,1696272,1696280,1696366-1696368,1696378,1696390,1696392,1696467,1698212,1698220,1700607,1700870,1700896,1700977,1701093,1701123,1701213,1701607,1701666,1701673,1701760-1701761,1701765,1701940,1702092,1702183,1702244,1702246,1702250,1702268,1702313,1702531,1702630-1702635,1702637-1702638,1702640,1702647,1702660,1702662,1702665-1702666,1702668,1702671-1702673,1702675-1702676,1702680,1702722,1702778,1702795,1702862,1702881,1702886,1702910,1702923,170
2971,1702984,1703024,1703040,1703044,1703049-1703050,1703143,1703146,1703151,1703160,1703164,1703167,1703174,1703192,1703287,1703290,1703358,1703408,1703486,1703509,1703523,1703542,1703545,1703554,1703584,1703673,1703676,1703678,1703680,1703763,1703784,1703821,1703842,1703849,1703851,1703853,1703856,1703860,1703865,1703890,1703948,1704149,1704151,1704251,1704278,1704289,1704302,1704305,1704307,1704318,1704331,1704647,1704658,1704689,1704702,1704706,1704711,1704730-1704733,1704735,1704739,1704741-1704742,1704744,1704786,1704867,1705231,1705630,1705635,1705639,1705647,1705650-1705652,1705842,1705848,1705865-1705866,1705942,1706017,1706744-1706745,1706853,1706915,1707052,1707088,1708500-1708501,1708504-1708505,1708570,1708649,1708687,1708745,1708957,1709120,1709266,1709295,1709375,1709663,1709895,1709960,1710070,1710134,1710341,1710346,1710441,1710445,1710489,1710517,1710523,1710571,1710577,1710632,1710676,1710689,1710753-1710754,1710779,1710924,1710930,1710933,1710945,1711006,1711016,
1711022,1711026,1712163,1712225,1712228,1712233,1712250,1712254,1712489,1712547-1712548,1712588,1712617,1712645,1712654,1712695,1712765-1712766,1712771,1712775,1712859,1712876,1712898,1712902,1712905,1712912,1712974,1713129,1713168,1713184,1713285,1713362,1713397,1713446,1713612,1713618,1713871,1713931,1713975,1713987,1713992,1713997,1714002,1714012,1714019,1714054,1714521,1714535,1714537,1715168,1715188,1715206,1715413,1715415,1715510-1715512,1715514-1715515,1715517-1715519,1715521,1715633,1715661,1715682,1715965,1716213-1716214,1716258,1716269,1716347,1716354,1716364,1716413,1716420,1716511,1716543,1716640,1716644,1716856,1716858,1716881-1716882,1716886,1716894,1717085,1717225,1717233,1717252,1717264,1717282,1717286,1717290,1717385,1717416,1717418,1717445,1717515,1717520,1717528,1717965,1717967-1717968,1717979,1718022,1718308,1718523,1718794,1718796,1718834,1718836-1718838,1719278,1719291,1719315,1719332,1719334,1719340,1719346,1719441,1719446,1719488,1719909-1719910,1720200,17202
34,1720394,1720439,1720445,1720448,1720462,1720506,1720652,1720654-1720655,1720711,1720752,1720769,1720776,1720804,1720815,1721303,1721307,1721311,1721314,1721447,1721528,1721539,1721812,1721817,1721830,1721860,1721866,1721881,1721887,1722205,1722292,1722399,1722453,1722455,1722522,1722526,1722532,1722548,1722574,1722583,1722585,1722799,1722807,1722824,1722828-1722829,1722831,1722859,1722902,1722905,1722923,1722939,1722945,1722996,1723068,1723127,1723155,1723250,1723316-1723318,1723368,1723371,1723375,1723377,1723380,1723410,1723414,1723437,1723484,1723486,1723493-1723494,1723500,1723552,1723554,1723683,1723707,1723736,1724012,1724232,1724252,1724325,1724427-1724428,1724433,1724673,1724788,1724863,1724900,1724997,1725113,1725126-1725127,1725150,1725165,1725183,1725199,1725202,1725204,1725207,1725263-1725264,1725266,1725278,1725282,1725405,1725599,1725601,1725635,1725646,1725649-1725652,1725694,1725696-1725697,1725816,1725851,1725906-1725907,1725910,1725914,1725920,1725926,1726177,17
26202,1726628,1726632,1726637,1726639,1726648,1726651,1726654,1726669,1726676,1726803,1726925-1726926,1726972-1726973,1726991,1727162,1727670,1727675,1727899,1727914,1727917,1728091,1728138,1728433,1728448,1729185,1729361,1729625,1729730,1730101-1730102,1730137,1730612,1730946,1730952,1730975,1731008,1731055,1731079,1731283,1731856,1731882,1731946,1731953,1731958,1731976,1731982-1731983,1732359,1732488,1732900,1733019,1733041,1733044,1733077,1733080,1733093,1733154,1733247,1733448,1733602,1733617,1733734,1733751
Modified: tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/ContainerMBean.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/ContainerMBean.java?rev=1733760&r1=1733759&r2=1733760&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/ContainerMBean.java (original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/ContainerMBean.java Sat Mar 5 20:43:54 2016
@@ -118,6 +118,7 @@ public class ContainerMBean extends Base
* Container.
*
* @param name Name of the existing child Container to be removed
+ * @throws MBeanException if the child cannot be removed
*/
public void removeChild(String name) throws MBeanException{
if(name != null){
@@ -139,8 +140,8 @@ public class ContainerMBean extends Base
* Adds a valve to this Container instance.
*
* @param valveType ClassName of the valve to be added
- *
- * @exception MBeanException if a component cannot be removed
+ * @return the MBean name of the new valve
+ * @throws MBeanException if adding the valve failed
*/
public String addValve(String valveType) throws MBeanException{
Valve valve = null;
@@ -222,7 +223,8 @@ public class ContainerMBean extends Base
* Add a LifecycleEvent listener to this component.
*
* @param type ClassName of the listener to add
- */
+ * @throws MBeanException if adding the listener failed
+ */
public void addLifecycleListener(String type) throws MBeanException{
LifecycleListener listener = null;
try {
@@ -254,6 +256,7 @@ public class ContainerMBean extends Base
*
* @param type The ClassName of the listeners to be removed.
* Note that all the listeners having given ClassName will be removed.
+ * @throws MBeanException propagated from the managed resource access
*/
public void removeLifecycleListeners(String type) throws MBeanException{
Container container=null;
@@ -279,6 +282,8 @@ public class ContainerMBean extends Base
/**
* List the class name of each of the lifecycle listeners added to this
* container.
+ * @return the lifecycle listeners class names
+ * @throws MBeanException propagated from the managed resource access
*/
public String[] findLifecycleListenerNames() throws MBeanException {
Container container = null;
@@ -306,6 +311,8 @@ public class ContainerMBean extends Base
/**
* List the class name of each of the container listeners added to this
* container.
+ * @return the container listeners class names
+ * @throws MBeanException propagated from the managed resource access
*/
public String[] findContainerListenerNames() throws MBeanException {
Container container = null;
Modified: tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/ContextMBean.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/ContextMBean.java?rev=1733760&r1=1733759&r2=1733760&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/ContextMBean.java (original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/ContextMBean.java Sat Mar 5 20:43:54 2016
@@ -38,6 +38,8 @@ public class ContextMBean extends Contai
/**
* Return the set of application parameters for this application.
+ * @return a string array with a representation of each parameter
+ * @throws MBeanException propagated from the managed resource access
*/
public String[] findApplicationParameters() throws MBeanException {
@@ -65,6 +67,9 @@ public class ContextMBean extends Contai
/**
* Return the security constraints for this web application.
* If there are none, a zero-length array is returned.
+ * @return a string array with a representation of each
+ * security constraint
+ * @throws MBeanException propagated from the managed resource access
*/
public String[] findConstraints() throws MBeanException {
@@ -94,6 +99,8 @@ public class ContextMBean extends Contai
* if any; otherwise return <code>null</code>.
*
* @param errorCode Error code to look up
+ * @return a string representation of the error page
+ * @throws MBeanException propagated from the managed resource access
*/
public String findErrorPage(int errorCode) throws MBeanException {
@@ -117,6 +124,8 @@ public class ContextMBean extends Contai
* if any; otherwise return <code>null</code>.
*
* @param exceptionType Exception type to look up
+ * @return a string representation of the error page
+ * @throws MBeanException propagated from the managed resource access
*/
public String findErrorPage(String exceptionType) throws MBeanException {
@@ -138,6 +147,8 @@ public class ContextMBean extends Contai
/**
* Return the set of defined error pages for all specified error codes
* and exception types.
+ * @return a string array with a representation of each error page
+ * @throws MBeanException propagated from the managed resource access
*/
public String[] findErrorPages() throws MBeanException {
@@ -167,6 +178,8 @@ public class ContextMBean extends Contai
* otherwise return <code>null</code>.
*
* @param name Filter name to look up
+ * @return a string representation of the filter definition
+ * @throws MBeanException propagated from the managed resource access
*/
public String findFilterDef(String name) throws MBeanException {
@@ -188,6 +201,9 @@ public class ContextMBean extends Contai
/**
* Return the set of defined filters for this Context.
+ * @return a string array with a representation of all
+ * the filter definitions
+ * @throws MBeanException propagated from the managed resource access
*/
public String[] findFilterDefs() throws MBeanException {
@@ -214,6 +230,8 @@ public class ContextMBean extends Contai
/**
* Return the set of filter mappings for this Context.
+ * @return a string array with a representation of all the filter mappings
+ * @throws MBeanException propagated from the managed resource access
*/
public String[] findFilterMaps() throws MBeanException {
Modified: tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/GroupMBean.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/GroupMBean.java?rev=1733760&r1=1733759&r2=1733760&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/GroupMBean.java (original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/GroupMBean.java Sat Mar 5 20:43:54 2016
@@ -81,7 +81,7 @@ public class GroupMBean extends BaseMode
/**
- * Return the MBean Names of all authorized roles for this group.
+ * @return the MBean Names of all authorized roles for this group.
*/
public String[] getRoles() {
@@ -108,7 +108,7 @@ public class GroupMBean extends BaseMode
/**
- * Return the MBean Names of all users that are members of this group.
+ * @return the MBean Names of all users that are members of this group.
*/
public String[] getUsers() {
Modified: tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MBeanDumper.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MBeanDumper.java?rev=1733760&r1=1733759&r2=1733760&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MBeanDumper.java (original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MBeanDumper.java Sat Mar 5 20:43:54 2016
@@ -42,7 +42,9 @@ public class MBeanDumper {
/**
* The following code to dump MBeans has been copied from JMXProxyServlet.
- *
+ * @param mbeanServer the MBean server
+ * @param names a set of object names for which to dump the info
+ * @return a string representation of the MBeans
*/
public static String dumpBeans(MBeanServer mbeanServer, Set<ObjectName> names)
{
Modified: tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MBeanFactory.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MBeanFactory.java?rev=1733760&r1=1733759&r2=1733760&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MBeanFactory.java (original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MBeanFactory.java Sat Mar 5 20:43:54 2016
@@ -76,6 +76,7 @@ public class MBeanFactory {
/**
* Set the container that this factory was created for.
+ * @param container The associated container
*/
public void setContainer(Object container) {
this.container = container;
@@ -194,6 +195,7 @@ public class MBeanFactory {
* @param parent MBean Name of the associated parent component
* @param address The IP address on which to bind
* @param port TCP port number to listen on
+ * @return the object name of the created connector
*
* @exception Exception if an MBean cannot be created or registered
*/
@@ -207,7 +209,13 @@ public class MBeanFactory {
* Create a new DataSource Realm.
*
* @param parent MBean Name of the associated parent component
- *
+ * @param dataSourceName the datasource name
+ * @param roleNameCol the column name for the role names
+ * @param userCredCol the column name for the user credentials
+ * @param userNameCol the column name for the user names
+ * @param userRoleTable the table name for the roles table
+ * @param userTable the table name for the users
+ * @return the object name of the created realm
* @exception Exception if an MBean cannot be created or registered
*/
public String createDataSourceRealm(String parent, String dataSourceName,
@@ -244,6 +252,7 @@ public class MBeanFactory {
* @param parent MBean Name of the associated parent component
* @param address The IP address on which to bind
* @param port TCP port number to listen on
+ * @return the object name of the created connector
*
* @exception Exception if an MBean cannot be created or registered
*/
@@ -295,6 +304,7 @@ public class MBeanFactory {
* @param parent MBean Name of the associated parent component
* @param address The IP address on which to bind
* @param port TCP port number to listen on
+ * @return the object name of the created connector
*
* @exception Exception if an MBean cannot be created or registered
*/
@@ -307,6 +317,11 @@ public class MBeanFactory {
* Create a new JDBC Realm.
*
* @param parent MBean Name of the associated parent component
+ * @param driverName JDBC driver name
+ * @param connectionName the user name for the connection
+ * @param connectionPassword the password for the connection
+ * @param connectionURL the connection URL to the database
+ * @return the object name of the created realm
*
* @exception Exception if an MBean cannot be created or registered
*/
@@ -342,6 +357,7 @@ public class MBeanFactory {
* Create a new JNDI Realm.
*
* @param parent MBean Name of the associated parent component
+ * @return the object name of the created realm
*
* @exception Exception if an MBean cannot be created or registered
*/
@@ -373,6 +389,7 @@ public class MBeanFactory {
* Create a new Memory Realm.
*
* @param parent MBean Name of the associated parent component
+ * @return the object name of the created realm
*
* @exception Exception if an MBean cannot be created or registered
*/
@@ -404,6 +421,7 @@ public class MBeanFactory {
* @param parent MBean Name of the associated parent component
* @param path The context path for this Context
* @param docBase Document base directory (or WAR) for this Context
+ * @return the object name of the created context
*
* @exception Exception if an MBean cannot be created or registered
*/
@@ -424,6 +442,7 @@ public class MBeanFactory {
* @param docBase Document base directory (or WAR) for this Context
* @param xmlValidation if XML descriptors should be validated
* @param xmlNamespaceAware if the XML processor should namespace aware
+ * @return the object name of the created context
*
* @exception Exception if an MBean cannot be created or registered
*/
@@ -493,6 +512,7 @@ public class MBeanFactory {
* @param deployOnStartup Deploy on server startup?
* @param deployXML Should we deploy Context XML config files property?
* @param unpackWARs Should we unpack WARs when auto deploying?
+ * @return the object name of the created host
*
* @exception Exception if an MBean cannot be created or registered
*/
@@ -536,6 +556,7 @@ public class MBeanFactory {
* @param domain Domain name for the container instance
* @param defaultHost Name of the default host to be used in the Engine
* @param baseDir Base directory value for Engine
+ * @return the object name of the created service
*
* @exception Exception if an MBean cannot be created or registered
*/
@@ -565,6 +586,7 @@ public class MBeanFactory {
* Create a new StandardManager.
*
* @param parent MBean Name of the associated parent component
+ * @return the object name of the created manager
*
* @exception Exception if an MBean cannot be created or registered
*/
@@ -598,6 +620,7 @@ public class MBeanFactory {
* @param parent MBean Name of the associated parent component
* @param resourceName Global JNDI resource name of the associated
* UserDatabase
+ * @return the object name of the created realm
*
* @exception Exception if an MBean cannot be created or registered
*/
@@ -638,6 +661,7 @@ public class MBeanFactory {
* @return The MBean name of the {@link Valve} that was created or
* <code>null</code> if the {@link Valve} does not implement
* {@link JmxEnabled}.
+ * @exception Exception if an MBean cannot be created or registered
*/
public String createValve(String className, String parent)
throws Exception {
@@ -667,6 +691,7 @@ public class MBeanFactory {
* Create a new Web Application Loader.
*
* @param parent MBean Name of the associated parent component
+ * @return the object name of the created loader
*
* @exception Exception if an MBean cannot be created or registered
*/
Modified: tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MBeanUtils.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MBeanUtils.java?rev=1733760&r1=1733759&r2=1733760&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MBeanUtils.java (original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MBeanUtils.java Sat Mar 5 20:43:54 2016
@@ -109,7 +109,7 @@ public class MBeanUtils {
* <code>ContextEnvironment</code> object.
*
* @param environment The ContextEnvironment to be managed
- *
+ * @return a new MBean
* @exception Exception if an MBean cannot be created or registered
*/
public static DynamicMBean createMBean(ContextEnvironment environment)
@@ -140,7 +140,7 @@ public class MBeanUtils {
* <code>ContextResource</code> object.
*
* @param resource The ContextResource to be managed
- *
+ * @return a new MBean
* @exception Exception if an MBean cannot be created or registered
*/
public static DynamicMBean createMBean(ContextResource resource)
@@ -171,7 +171,7 @@ public class MBeanUtils {
* <code>ContextResourceLink</code> object.
*
* @param resourceLink The ContextResourceLink to be managed
- *
+ * @return a new MBean
* @exception Exception if an MBean cannot be created or registered
*/
public static DynamicMBean createMBean(ContextResourceLink resourceLink)
@@ -202,7 +202,7 @@ public class MBeanUtils {
* <code>Group</code> object.
*
* @param group The Group to be managed
- *
+ * @return a new MBean
* @exception Exception if an MBean cannot be created or registered
*/
static DynamicMBean createMBean(Group group)
@@ -233,7 +233,7 @@ public class MBeanUtils {
* <code>Role</code> object.
*
* @param role The Role to be managed
- *
+ * @return a new MBean
* @exception Exception if an MBean cannot be created or registered
*/
static DynamicMBean createMBean(Role role)
@@ -264,7 +264,7 @@ public class MBeanUtils {
* <code>User</code> object.
*
* @param user The User to be managed
- *
+ * @return a new MBean
* @exception Exception if an MBean cannot be created or registered
*/
static DynamicMBean createMBean(User user)
@@ -295,7 +295,7 @@ public class MBeanUtils {
* <code>UserDatabase</code> object.
*
* @param userDatabase The UserDatabase to be managed
- *
+ * @return a new MBean
* @exception Exception if an MBean cannot be created or registered
*/
static DynamicMBean createMBean(UserDatabase userDatabase)
@@ -327,7 +327,7 @@ public class MBeanUtils {
*
* @param domain Domain in which this name is to be created
* @param environment The ContextEnvironment to be named
- *
+ * @return a new object name
* @exception MalformedObjectNameException if a name cannot be created
*/
public static ObjectName createObjectName(String domain,
@@ -360,7 +360,7 @@ public class MBeanUtils {
*
* @param domain Domain in which this name is to be created
* @param resource The ContextResource to be named
- *
+ * @return a new object name
* @exception MalformedObjectNameException if a name cannot be created
*/
public static ObjectName createObjectName(String domain,
@@ -397,7 +397,7 @@ public class MBeanUtils {
*
* @param domain Domain in which this name is to be created
* @param resourceLink The ContextResourceLink to be named
- *
+ * @return a new object name
* @exception MalformedObjectNameException if a name cannot be created
*/
public static ObjectName createObjectName(String domain,
@@ -434,7 +434,7 @@ public class MBeanUtils {
*
* @param domain Domain in which this name is to be created
* @param group The Group to be named
- *
+ * @return a new object name
* @exception MalformedObjectNameException if a name cannot be created
*/
static ObjectName createObjectName(String domain,
@@ -456,7 +456,7 @@ public class MBeanUtils {
*
* @param domain Domain in which this name is to be created
* @param loader The Loader to be named
- *
+ * @return a new object name
* @exception MalformedObjectNameException if a name cannot be created
*/
static ObjectName createObjectName(String domain, Loader loader)
@@ -480,7 +480,7 @@ public class MBeanUtils {
*
* @param domain Domain in which this name is to be created
* @param role The Role to be named
- *
+ * @return a new object name
* @exception MalformedObjectNameException if a name cannot be created
*/
static ObjectName createObjectName(String domain, Role role)
@@ -499,7 +499,7 @@ public class MBeanUtils {
*
* @param domain Domain in which this name is to be created
* @param user The User to be named
- *
+ * @return a new object name
* @exception MalformedObjectNameException if a name cannot be created
*/
static ObjectName createObjectName(String domain, User user)
@@ -518,7 +518,7 @@ public class MBeanUtils {
*
* @param domain Domain in which this name is to be created
* @param userDatabase The UserDatabase to be named
- *
+ * @return a new object name
* @exception MalformedObjectNameException if a name cannot be created
*/
static ObjectName createObjectName(String domain,
@@ -535,6 +535,7 @@ public class MBeanUtils {
/**
* Create and configure (if necessary) and return the registry of
* managed object descriptions.
+ * @return the singleton registry
*/
public static synchronized Registry createRegistry() {
@@ -567,6 +568,7 @@ public class MBeanUtils {
* Create and configure (if necessary) and return the
* <code>MBeanServer</code> with which we will be
* registering our <code>DynamicMBean</code> implementations.
+ * @return the singleton MBean server
*/
public static synchronized MBeanServer createServer() {
Modified: tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MemoryUserDatabaseMBean.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MemoryUserDatabaseMBean.java?rev=1733760&r1=1733759&r2=1733760&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MemoryUserDatabaseMBean.java (original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/MemoryUserDatabaseMBean.java Sat Mar 5 20:43:54 2016
@@ -104,7 +104,7 @@ public class MemoryUserDatabaseMBean ext
/**
- * Return the MBean Names of all groups defined in this database.
+ * @return the MBean Names of all groups defined in this database.
*/
public String[] getGroups() {
@@ -121,7 +121,7 @@ public class MemoryUserDatabaseMBean ext
/**
- * Return the MBean Names of all roles defined in this database.
+ * @return the MBean Names of all roles defined in this database.
*/
public String[] getRoles() {
@@ -138,7 +138,7 @@ public class MemoryUserDatabaseMBean ext
/**
- * Return the MBean Names of all users defined in this database.
+ * @return the MBean Names of all users defined in this database.
*/
public String[] getUsers() {
@@ -162,6 +162,7 @@ public class MemoryUserDatabaseMBean ext
*
* @param groupname Group name of the new group
* @param description Description of the new group
+ * @return the new group object name
*/
public String createGroup(String groupname, String description) {
@@ -185,6 +186,7 @@ public class MemoryUserDatabaseMBean ext
*
* @param rolename Group name of the new group
* @param description Description of the new group
+ * @return the new role object name
*/
public String createRole(String rolename, String description) {
@@ -209,6 +211,7 @@ public class MemoryUserDatabaseMBean ext
* @param username User name of the new user
* @param password Password for the new user
* @param fullName Full name for the new user
+ * @return the new user object name
*/
public String createUser(String username, String password,
String fullName) {
@@ -233,6 +236,7 @@ public class MemoryUserDatabaseMBean ext
* otherwise return <code>null</code>.
*
* @param groupname Group name to look up
+ * @return the group object name
*/
public String findGroup(String groupname) {
@@ -260,6 +264,7 @@ public class MemoryUserDatabaseMBean ext
* otherwise return <code>null</code>.
*
* @param rolename Role name to look up
+ * @return the role object name
*/
public String findRole(String rolename) {
@@ -287,6 +292,7 @@ public class MemoryUserDatabaseMBean ext
* otherwise return <code>null</code>.
*
* @param username User name to look up
+ * @return the user object name
*/
public String findUser(String username) {
Modified: tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/NamingResourcesMBean.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/NamingResourcesMBean.java?rev=1733760&r1=1733759&r2=1733760&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/NamingResourcesMBean.java (original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/NamingResourcesMBean.java Sat Mar 5 20:43:54 2016
@@ -81,6 +81,7 @@ public class NamingResourcesMBean extend
/**
* Return the MBean Names of the set of defined environment entries for
* this web application
+ * @return an array of object names as strings
*/
public String[] getEnvironments() {
ContextEnvironment[] envs =
@@ -106,6 +107,7 @@ public class NamingResourcesMBean extend
/**
* Return the MBean Names of all the defined resource references for this
* application.
+ * @return an array of object names as strings
*/
public String[] getResources() {
@@ -132,6 +134,7 @@ public class NamingResourcesMBean extend
/**
* Return the MBean Names of all the defined resource link references for
* this application.
+ * @return an array of object names as strings
*/
public String[] getResourceLinks() {
@@ -163,6 +166,8 @@ public class NamingResourcesMBean extend
* @param envName New environment entry name
* @param type The type of the new environment entry
* @param value The value of the new environment entry
+ * @return the object name of the new environment entry
+ * @throws MalformedObjectNameException if the object name was invalid
*/
public String addEnvironment(String envName, String type, String value)
throws MalformedObjectNameException {
@@ -196,6 +201,8 @@ public class NamingResourcesMBean extend
*
* @param resourceName New resource reference name
* @param type New resource reference type
+ * @return the object name of the new resource
+ * @throws MalformedObjectNameException if the object name was invalid
*/
public String addResource(String resourceName, String type)
throws MalformedObjectNameException {
@@ -227,6 +234,8 @@ public class NamingResourcesMBean extend
*
* @param resourceLinkName New resource link reference name
* @param type New resource link reference type
+ * @return the object name of the new resource link
+ * @throws MalformedObjectNameException if the object name was invalid
*/
public String addResourceLink(String resourceLinkName, String type)
throws MalformedObjectNameException {
Modified: tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/ServiceMBean.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/ServiceMBean.java?rev=1733760&r1=1733759&r2=1733760&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/ServiceMBean.java (original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/ServiceMBean.java Sat Mar 5 20:43:54 2016
@@ -45,7 +45,7 @@ public class ServiceMBean extends BaseMo
* @param isAjp Create a AJP/1.3 Connector
* @param isSSL Create a secure Connector
*
- * @throws MBeanException
+ * @throws MBeanException error creating the connector
*/
public void addConnector(String address, int port, boolean isAjp, boolean isSSL) throws MBeanException {
@@ -75,7 +75,7 @@ public class ServiceMBean extends BaseMo
/**
* Adds a named executor to the service
* @param type Classname of the Executor to be added
- * @throws MBeanException
+ * @throws MBeanException error creating the executor
*/
public void addExecutor(String type) throws MBeanException {
@@ -107,7 +107,8 @@ public class ServiceMBean extends BaseMo
/**
* Find and return the set of Connectors associated with this Service.
- * @throws MBeanException
+ * @return an array of string representations of the connectors
+ * @throws MBeanException error accessing the associated service
*/
public String[] findConnectors() throws MBeanException {
@@ -134,8 +135,9 @@ public class ServiceMBean extends BaseMo
}
/**
- * Retrieves all executors
- * @throws MBeanException
+ * Retrieves all executors.
+ * @return an array of string representations of the executors
+ * @throws MBeanException error accessing the associated service
*/
public String[] findExecutors() throws MBeanException {
@@ -163,7 +165,8 @@ public class ServiceMBean extends BaseMo
/**
* Retrieves executor by name
* @param name Name of the executor to be retrieved
- * @throws MBeanException
+ * @return a string representation of the executor
+ * @throws MBeanException error accessing the associated service
*/
public String getExecutor(String name) throws MBeanException{
Modified: tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/UserMBean.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/UserMBean.java?rev=1733760&r1=1733759&r2=1733760&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/UserMBean.java (original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/mbeans/UserMBean.java Sat Mar 5 20:43:54 2016
@@ -82,7 +82,7 @@ public class UserMBean extends BaseModel
/**
- * Return the MBean Names of all groups this user is a member of.
+ * @return the MBean Names of all groups this user is a member of.
*/
public String[] getGroups() {
@@ -109,7 +109,7 @@ public class UserMBean extends BaseModel
/**
- * Return the MBean Names of all roles assigned to this user.
+ * @return the MBean Names of all roles assigned to this user.
*/
public String[] getRoles() {
Modified: tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/CombinedRealm.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/CombinedRealm.java?rev=1733760&r1=1733759&r2=1733760&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/CombinedRealm.java (original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/CombinedRealm.java Sat Mar 5 20:43:54 2016
@@ -58,6 +58,7 @@ public class CombinedRealm extends Realm
/**
* Add a realm to the list of realms that will be used to authenticate
* users.
+ * @param theRealm realm which should be wrapped by the combined realm
*/
public void addRealm(Realm theRealm) {
realms.add(theRealm);
@@ -71,7 +72,7 @@ public class CombinedRealm extends Realm
/**
- * Return the set of Realms that this Realm is wrapping
+ * @return the set of Realms that this Realm is wrapping
*/
public ObjectName[] getRealms() {
ObjectName[] result = new ObjectName[realms.size()];
@@ -85,7 +86,7 @@ public class CombinedRealm extends Realm
}
/**
- * Return the list of Realms contained by this Realm.
+ * @return the list of Realms contained by this Realm.
*/
public Realm[] getNestedRealms() {
return realms.toArray(new Realm[0]);
Modified: tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/DataSourceRealm.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/DataSourceRealm.java?rev=1733760&r1=1733759&r2=1733760&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/DataSourceRealm.java (original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/DataSourceRealm.java Sat Mar 5 20:43:54 2016
@@ -111,8 +111,7 @@ public class DataSourceRealm extends Rea
/**
- * Return the name of the JNDI JDBC DataSource.
- *
+ * @return the name of the JNDI JDBC DataSource.
*/
public String getDataSourceName() {
return dataSourceName;
@@ -128,7 +127,7 @@ public class DataSourceRealm extends Rea
}
/**
- * Return if the datasource will be looked up in the webapp JNDI Context.
+ * @return if the datasource will be looked up in the webapp JNDI Context.
*/
public boolean getLocalDataSource() {
return localDataSource;
@@ -145,8 +144,7 @@ public class DataSourceRealm extends Rea
}
/**
- * Return the column in the user role table that names a role.
- *
+ * @return the column in the user role table that names a role.
*/
public String getRoleNameCol() {
return roleNameCol;
@@ -162,8 +160,7 @@ public class DataSourceRealm extends Rea
}
/**
- * Return the column in the user table that holds the user's credentials.
- *
+ * @return the column in the user table that holds the user's credentials.
*/
public String getUserCredCol() {
return userCredCol;
@@ -179,8 +176,7 @@ public class DataSourceRealm extends Rea
}
/**
- * Return the column in the user table that holds the user's name.
- *
+ * @return the column in the user table that holds the user's name.
*/
public String getUserNameCol() {
return userNameCol;
@@ -196,8 +192,7 @@ public class DataSourceRealm extends Rea
}
/**
- * Return the table that holds the relation between user's and roles.
- *
+ * @return the table that holds the relation between user's and roles.
*/
public String getUserRoleTable() {
return userRoleTable;
@@ -213,8 +208,7 @@ public class DataSourceRealm extends Rea
}
/**
- * Return the table that holds user data..
- *
+ * @return the table that holds user data..
*/
public String getUserTable() {
return userTable;
@@ -244,6 +238,7 @@ public class DataSourceRealm extends Rea
* @param username Username of the Principal to look up
* @param credentials Password or other credentials to use in
* authenticating this username
+ * @return the associated principal, or <code>null</code> if there is none.
*/
@Override
public Principal authenticate(String username, String credentials) {
@@ -289,6 +284,7 @@ public class DataSourceRealm extends Rea
* @param username Username of the Principal to look up
* @param credentials Password or other credentials to use in
* authenticating this username
+ * @return the associated principal, or <code>null</code> if there is none.
*/
protected Principal authenticate(Connection dbConnection,
String username,
@@ -391,7 +387,7 @@ public class DataSourceRealm extends Rea
}
/**
- * Return the password associated with the given principal's user name.
+ * @return the password associated with the given principal's user name.
*/
@Override
protected String getPassword(String username) {
@@ -415,6 +411,7 @@ public class DataSourceRealm extends Rea
* Return the password associated with the given principal's user name.
* @param dbConnection The database connection to be used
* @param username Username for which password should be retrieved
+ * @return the password for the specified user
*/
protected String getPassword(Connection dbConnection,
String username) {
@@ -441,6 +438,8 @@ public class DataSourceRealm extends Rea
/**
* Return the Principal associated with the given user name.
+ * @param username the user name
+ * @return the principal object
*/
@Override
protected Principal getPrincipal(String username) {
@@ -460,7 +459,8 @@ public class DataSourceRealm extends Rea
/**
* Return the roles associated with the given user name.
- * @param username Username for which roles should be retrieved
+ * @param username User name for which roles should be retrieved
+ * @return an array list of the role names
*/
protected ArrayList<String> getRoles(String username) {
@@ -482,7 +482,8 @@ public class DataSourceRealm extends Rea
/**
* Return the roles associated with the given user name
* @param dbConnection The database connection to be used
- * @param username Username for which roles should be retrieved
+ * @param username User name for which roles should be retrieved
+ * @return an array list of the role names
*/
protected ArrayList<String> getRoles(Connection dbConnection,
String username) {
@@ -519,8 +520,8 @@ public class DataSourceRealm extends Rea
* to retrieve user credentials for the specified username.
*
* @param dbConnection The database connection to be used
- * @param username Username for which credentials should be retrieved
- *
+ * @param username User name for which credentials should be retrieved
+ * @return the prepared statement
* @exception SQLException if a database error occurs
*/
private PreparedStatement credentials(Connection dbConnection,
@@ -540,8 +541,8 @@ public class DataSourceRealm extends Rea
* to retrieve user roles for the specified username.
*
* @param dbConnection The database connection to be used
- * @param username Username for which roles should be retrieved
- *
+ * @param username User name for which roles should be retrieved
+ * @return the prepared statement
* @exception SQLException if a database error occurs
*/
private PreparedStatement roles(Connection dbConnection, String username)
Modified: tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/DigestCredentialHandlerBase.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/DigestCredentialHandlerBase.java?rev=1733760&r1=1733759&r2=1733760&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/DigestCredentialHandlerBase.java (original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/DigestCredentialHandlerBase.java Sat Mar 5 20:43:54 2016
@@ -42,7 +42,7 @@ public abstract class DigestCredentialHa
/**
- * Return the number of iterations of the associated algorithm that will be
+ * @return the number of iterations of the associated algorithm that will be
* used when creating a new stored credential for a given input credential.
*/
public int getIterations() {
@@ -53,6 +53,7 @@ public abstract class DigestCredentialHa
/**
* Set the number of iterations of the associated algorithm that will be
* used when creating a new stored credential for a given input credential.
+ * @param iterations the iterations count
*/
public void setIterations(int iterations) {
this.iterations = iterations;
@@ -60,7 +61,7 @@ public abstract class DigestCredentialHa
/**
- * Return the salt length that will be used when creating a new stored
+ * @return the salt length that will be used when creating a new stored
* credential for a given input credential.
*/
public int getSaltLength() {
@@ -71,6 +72,7 @@ public abstract class DigestCredentialHa
/**
* Set the salt length that will be used when creating a new stored
* credential for a given input credential.
+ * @param saltLength the salt length
*/
public void setSaltLength(int saltLength) {
this.saltLength = saltLength;
@@ -80,6 +82,7 @@ public abstract class DigestCredentialHa
/**
* When checking input credentials against stored credentials will a warning
* message be logged if invalid stored credentials are discovered?
+ * @return <code>true</code> if logging will occur
*/
public boolean getLogInvalidStoredCredentials() {
return logInvalidStoredCredentials;
@@ -90,6 +93,8 @@ public abstract class DigestCredentialHa
* Set whether a warning message will be logged if invalid stored
* credentials are discovered while checking input credentials against
* stored credentials?
+ * @param logInvalidStoredCredentials <code>true</code> to log, the
+ * default value is <code>false</code>
*/
public void setLogInvalidStoredCredentials(boolean logInvalidStoredCredentials) {
this.logInvalidStoredCredentials = logInvalidStoredCredentials;
@@ -189,7 +194,7 @@ public abstract class DigestCredentialHa
/**
- * Get the default salt length used by the {@link CredentialHandler}.
+ * @return the default salt length used by the {@link CredentialHandler}.
*/
protected int getDefaultSaltLength() {
return DEFAULT_SALT_LENGTH;
@@ -215,26 +220,29 @@ public abstract class DigestCredentialHa
/**
* Set the algorithm used to convert input credentials to stored
* credentials.
+ * @param algorithm the algorithm
+ * @throws NoSuchAlgorithmException if the specified algorithm
+ * is not supported
*/
public abstract void setAlgorithm(String algorithm) throws NoSuchAlgorithmException;
/**
- * Get the algorithm used to convert input credentials to stored
+ * @return the algorithm used to convert input credentials to stored
* credentials.
*/
public abstract String getAlgorithm();
/**
- * Get the default number of iterations used by the
+ * @return the default number of iterations used by the
* {@link CredentialHandler}.
*/
protected abstract int getDefaultIterations();
/**
- * Obtain the logger for the CredentialHandler instance.
+ * @return the logger for the CredentialHandler instance.
*/
protected abstract Log getLog();
}
Modified: tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/JAASRealm.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/JAASRealm.java?rev=1733760&r1=1733759&r2=1733760&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/JAASRealm.java (original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/JAASRealm.java Sat Mar 5 20:43:54 2016
@@ -178,28 +178,31 @@ public class JAASRealm extends RealmBase
// ------------------------------------------------------------- Properties
/**
- * Getter for the <code>configfile</code> member variable.
+ * @return the path of the JAAS configuration file.
*/
public String getConfigFile() {
return configFile;
}
/**
- * Setter for the <code>configfile</code> member variable.
+ * Set the JAAS configuration file.
+ * @param configFile The JAAS configuration file
*/
public void setConfigFile(String configFile) {
this.configFile = configFile;
}
/**
- * setter for the <code>appName</code> member variable
+ * Set the JAAS <code>LoginContext</code> app name.
+ * @param name The application name that will be used to retrieve
+ * the set of relevant <code>LoginModule</code>s
*/
public void setAppName(String name) {
appName = name;
}
/**
- * getter for the <code>appName</code> member variable
+ * @return the application name.
*/
public String getAppName() {
return appName;
@@ -258,6 +261,7 @@ public class JAASRealm extends RealmBase
* classes in the list must implement <code>java.security.Principal</code>.
* The supplied list of classes will be parsed when {@link #start()} is
* called.
+ * @param roleClassNames The class names list
*/
public void setRoleClassNames(String roleClassNames) {
this.roleClassNames = roleClassNames;
@@ -313,6 +317,7 @@ public class JAASRealm extends RealmBase
* users. The classes in the list must implement
* <code>java.security.Principal</code>. The supplied list of classes will
* be parsed when {@link #start()} is called.
+ * @param userClassNames The class names list
*/
public void setUserClassNames(String userClassNames) {
this.userClassNames = userClassNames;
@@ -328,6 +333,7 @@ public class JAASRealm extends RealmBase
* @param username Username of the <code>Principal</code> to look up
* @param credentials Password or other credentials to use in
* authenticating this username
+ * @return the associated principal, or <code>null</code> if there is none.
*/
@Override
public Principal authenticate(String username, String credentials) {
@@ -349,6 +355,7 @@ public class JAASRealm extends RealmBase
* @param realmName Realm name
* @param md5a2 Second MD5 digest used to calculate the digest
* MD5(Method + ":" + uri)
+ * @return the associated principal, or <code>null</code> if there is none.
*/
@Override
public Principal authenticate(String username, String clientDigest,
@@ -368,7 +375,10 @@ public class JAASRealm extends RealmBase
/**
- * Perform the actual JAAS authentication
+ * Perform the actual JAAS authentication.
+ * @param username The user name
+ * @param callbackHandler The callback handler
+ * @return the associated principal, or <code>null</code> if there is none.
*/
protected Principal authenticate(String username,
CallbackHandler callbackHandler) {
@@ -459,7 +469,7 @@ public class JAASRealm extends RealmBase
}
/**
- * Return a short name for this <code>Realm</code> implementation.
+ * @return a short name for this <code>Realm</code> implementation.
*/
@Override
protected String getName() {
@@ -470,7 +480,7 @@ public class JAASRealm extends RealmBase
/**
- * Return the password associated with the given principal's user name. This
+ * @return the password associated with the given principal's user name. This
* always returns null as the JAASRealm has no way of obtaining this
* information.
*/
@@ -483,7 +493,7 @@ public class JAASRealm extends RealmBase
/**
- * Return the <code>Principal</code> associated with the given user name.
+ * @return the <code>Principal</code> associated with the given user name.
*/
@Override
protected Principal getPrincipal(String username) {
@@ -505,9 +515,11 @@ public class JAASRealm extends RealmBase
* Any remaining principal objects returned by the LoginModules are mapped to
* roles, but only if their respective classes match one of the "role class" classes.
* If a user Principal cannot be constructed, return <code>null</code>.
+ * @param username The associated user name
* @param subject The <code>Subject</code> representing the logged-in user
* @param loginContext Associated with the Principal so
* {@link LoginContext#logout()} can be called later
+ * @return the principal object
*/
protected Principal createPrincipal(String username, Subject subject,
LoginContext loginContext) {
@@ -612,7 +624,8 @@ public class JAASRealm extends RealmBase
/**
- * Load custom JAAS Configuration
+ * Load custom JAAS Configuration.
+ * @return the loaded configuration
*/
protected Configuration getConfig() {
try {
Modified: tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/JDBCRealm.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/JDBCRealm.java?rev=1733760&r1=1733759&r2=1733760&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/JDBCRealm.java (original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/JDBCRealm.java Sat Mar 5 20:43:54 2016
@@ -143,8 +143,7 @@ public class JDBCRealm
// ------------------------------------------------------------- Properties
/**
- * Return the username to use to connect to the database.
- *
+ * @return the username to use to connect to the database.
*/
public String getConnectionName() {
return connectionName;
@@ -160,8 +159,7 @@ public class JDBCRealm
}
/**
- * Return the password to use to connect to the database.
- *
+ * @return the password to use to connect to the database.
*/
public String getConnectionPassword() {
return connectionPassword;
@@ -177,8 +175,7 @@ public class JDBCRealm
}
/**
- * Return the URL to use to connect to the database.
- *
+ * @return the URL to use to connect to the database.
*/
public String getConnectionURL() {
return connectionURL;
@@ -194,8 +191,7 @@ public class JDBCRealm
}
/**
- * Return the JDBC driver that will be used.
- *
+ * @return the JDBC driver that will be used.
*/
public String getDriverName() {
return driverName;
@@ -211,8 +207,7 @@ public class JDBCRealm
}
/**
- * Return the column in the user role table that names a role.
- *
+ * @return the column in the user role table that names a role.
*/
public String getRoleNameCol() {
return roleNameCol;
@@ -228,8 +223,7 @@ public class JDBCRealm
}
/**
- * Return the column in the user table that holds the user's credentials.
- *
+ * @return the column in the user table that holds the user's credentials.
*/
public String getUserCredCol() {
return userCredCol;
@@ -245,8 +239,7 @@ public class JDBCRealm
}
/**
- * Return the column in the user table that holds the user's name.
- *
+ * @return the column in the user table that holds the user's name.
*/
public String getUserNameCol() {
return userNameCol;
@@ -262,8 +255,7 @@ public class JDBCRealm
}
/**
- * Return the table that holds the relation between user's and roles.
- *
+ * @return the table that holds the relation between user's and roles.
*/
public String getUserRoleTable() {
return userRoleTable;
@@ -279,8 +271,7 @@ public class JDBCRealm
}
/**
- * Return the table that holds user data..
- *
+ * @return the table that holds user data..
*/
public String getUserTable() {
return userTable;
@@ -311,6 +302,7 @@ public class JDBCRealm
* @param username Username of the Principal to look up
* @param credentials Password or other credentials to use in
* authenticating this username
+ * @return the associated principal, or <code>null</code> if there is none.
*/
@Override
public synchronized Principal authenticate(String username, String credentials) {
@@ -463,7 +455,7 @@ public class JDBCRealm
*
* @param dbConnection The database connection to be used
* @param username Username for which credentials should be retrieved
- *
+ * @return the prepared statement
* @exception SQLException if a database error occurs
*/
protected PreparedStatement credentials(Connection dbConnection,
@@ -498,7 +490,7 @@ public class JDBCRealm
/**
- * Return a short name for this Realm implementation.
+ * @return a short name for this Realm implementation.
*/
@Override
protected String getName() {
@@ -509,7 +501,9 @@ public class JDBCRealm
/**
- * Return the password associated with the given principal's user name.
+ * Get the password for the specified user.
+ * @param username The user name
+ * @return the password associated with the given principal's user name.
*/
@Override
protected synchronized String getPassword(String username) {
@@ -562,7 +556,9 @@ public class JDBCRealm
}
/**
- * Return the Principal associated with the given user name.
+ * Get the principal associated with the specified user.
+ * @param username The user name
+ * @return the Principal associated with the given user name.
*/
@Override
protected synchronized Principal getPrincipal(String username) {
@@ -575,7 +571,9 @@ public class JDBCRealm
/**
- * Return the roles associated with the gven user name.
+ * Return the roles associated with the given user name.
+ * @param username The user name
+ * @return an array list of the role names
*/
protected ArrayList<String> getRoles(String username) {
@@ -634,7 +632,7 @@ public class JDBCRealm
/**
* Open (if necessary) and return a database connection for use by
* this Realm.
- *
+ * @return the opened connection
* @exception SQLException if a database error occurs
*/
protected Connection open() throws SQLException {
@@ -677,7 +675,7 @@ public class JDBCRealm
*
* @param dbConnection The database connection to be used
* @param username Username for which roles should be retrieved
- *
+ * @return the prepared statement
* @exception SQLException if a database error occurs
*/
protected synchronized PreparedStatement roles(Connection dbConnection,
Modified: tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/JNDIRealm.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/JNDIRealm.java?rev=1733760&r1=1733759&r2=1733760&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/JNDIRealm.java (original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/realm/JNDIRealm.java Sat Mar 5 20:43:54 2016
@@ -501,7 +501,7 @@ public class JNDIRealm extends RealmBase
// ------------------------------------------------------------- Properties
/**
- * Return the type of authentication to use.
+ * @return the type of authentication to use.
*/
public String getAuthentication() {
@@ -521,7 +521,7 @@ public class JNDIRealm extends RealmBase
}
/**
- * Return the connection username for this Realm.
+ * @return the connection username for this Realm.
*/
public String getConnectionName() {
@@ -543,7 +543,7 @@ public class JNDIRealm extends RealmBase
/**
- * Return the connection password for this Realm.
+ * @return the connection password for this Realm.
*/
public String getConnectionPassword() {
@@ -565,7 +565,7 @@ public class JNDIRealm extends RealmBase
/**
- * Return the connection URL for this Realm.
+ * @return the connection URL for this Realm.
*/
public String getConnectionURL() {
@@ -587,7 +587,7 @@ public class JNDIRealm extends RealmBase
/**
- * Return the JNDI context factory for this Realm.
+ * @return the JNDI context factory for this Realm.
*/
public String getContextFactory() {
@@ -608,7 +608,7 @@ public class JNDIRealm extends RealmBase
}
/**
- * Return the derefAliases setting to be used.
+ * @return the derefAliases setting to be used.
*/
public java.lang.String getDerefAliases() {
return derefAliases;
@@ -624,7 +624,7 @@ public class JNDIRealm extends RealmBase
}
/**
- * Return the protocol to be used.
+ * @return the protocol to be used.
*/
public String getProtocol() {
@@ -645,7 +645,7 @@ public class JNDIRealm extends RealmBase
/**
- * Returns the current settings for handling PartialResultExceptions
+ * @return the current settings for handling PartialResultExceptions
*/
public boolean getAdCompat () {
return adCompat;
@@ -655,6 +655,7 @@ public class JNDIRealm extends RealmBase
/**
* How do we handle PartialResultExceptions?
* True: ignore all PartialResultExceptions.
+ * @param adCompat <code>true</code> to ignore patial results
*/
public void setAdCompat (boolean adCompat) {
this.adCompat = adCompat;
@@ -662,7 +663,7 @@ public class JNDIRealm extends RealmBase
/**
- * Returns the current settings for handling JNDI referrals.
+ * @return the current settings for handling JNDI referrals.
*/
public String getReferrals () {
return referrals;
@@ -672,6 +673,7 @@ public class JNDIRealm extends RealmBase
/**
* How do we handle JNDI referrals? ignore, follow, or throw
* (see javax.naming.Context.REFERRAL for more information).
+ * @param referrals The referral handling
*/
public void setReferrals (String referrals) {
this.referrals = referrals;
@@ -679,7 +681,7 @@ public class JNDIRealm extends RealmBase
/**
- * Return the base element for user searches.
+ * @return the base element for user searches.
*/
public String getUserBase() {
@@ -701,7 +703,7 @@ public class JNDIRealm extends RealmBase
/**
- * Return the message format pattern for selecting users in this Realm.
+ * @return the message format pattern for selecting users in this Realm.
*/
public String getUserSearch() {
@@ -737,7 +739,7 @@ public class JNDIRealm extends RealmBase
/**
- * Return the "search subtree for users" flag.
+ * @return the "search subtree for users" flag.
*/
public boolean getUserSubtree() {
@@ -759,7 +761,7 @@ public class JNDIRealm extends RealmBase
/**
- * Return the user role name attribute name for this Realm.
+ * @return the user role name attribute name for this Realm.
*/
public String getUserRoleName() {
@@ -780,7 +782,7 @@ public class JNDIRealm extends RealmBase
/**
- * Return the base element for role searches.
+ * @return the base element for role searches.
*/
public String getRoleBase() {
@@ -806,7 +808,7 @@ public class JNDIRealm extends RealmBase
/**
- * Return the role name attribute name for this Realm.
+ * @return the role name attribute name for this Realm.
*/
public String getRoleName() {
@@ -828,7 +830,7 @@ public class JNDIRealm extends RealmBase
/**
- * Return the message format pattern for selecting roles in this Realm.
+ * @return the message format pattern for selecting roles in this Realm.
*/
public String getRoleSearch() {
@@ -864,7 +866,7 @@ public class JNDIRealm extends RealmBase
/**
- * Return the "search subtree for roles" flag.
+ * @return the "search subtree for roles" flag.
*/
public boolean getRoleSubtree() {
@@ -885,7 +887,7 @@ public class JNDIRealm extends RealmBase
}
/**
- * Return the "The nested group search flag" flag.
+ * @return the "The nested group search flag" flag.
*/
public boolean getRoleNested() {
@@ -907,7 +909,7 @@ public class JNDIRealm extends RealmBase
/**
- * Return the password attribute used to retrieve the user password.
+ * @return the password attribute used to retrieve the user password.
*/
public String getUserPassword() {
@@ -937,7 +939,7 @@ public class JNDIRealm extends RealmBase
}
/**
- * Return the message format pattern for selecting users in this Realm.
+ * @return the message format pattern for selecting users in this Realm.
*/
public String getUserPattern() {
@@ -1000,7 +1002,7 @@ public class JNDIRealm extends RealmBase
/**
- * Return the common role
+ * @return the common role
*/
public String getCommonRole() {
@@ -1022,7 +1024,7 @@ public class JNDIRealm extends RealmBase
/**
- * Return the connection timeout.
+ * @return the connection timeout.
*/
public String getConnectionTimeout() {
@@ -1244,6 +1246,7 @@ public class JNDIRealm extends RealmBase
* @param username Username of the Principal to look up
* @param credentials Password or other credentials to use in
* authenticating this username
+ * @return the associated principal, or <code>null</code> if there is none.
*/
@Override
public Principal authenticate(String username, String credentials) {
@@ -1352,6 +1355,7 @@ public class JNDIRealm extends RealmBase
* @param username Username of the Principal to look up
* @param credentials Password or other credentials to use in
* authenticating this username
+ * @return the associated principal, or <code>null</code> if there is none.
*
* @exception NamingException if a directory server error occurs
*/
@@ -1434,7 +1438,7 @@ public class JNDIRealm extends RealmBase
*
* @param context The directory context
* @param username Username to be looked up
- *
+ * @return the User object
* @exception NamingException if a directory server error occurs
*
* @see #getUser(DirContext, String, String, int)
@@ -1454,7 +1458,7 @@ public class JNDIRealm extends RealmBase
* @param context The directory context
* @param username Username to be looked up
* @param credentials User credentials (optional)
- *
+ * @return the User object
* @exception NamingException if a directory server error occurs
*
* @see #getUser(DirContext, String, String, int)
@@ -1481,7 +1485,7 @@ public class JNDIRealm extends RealmBase
* @param username Username to be looked up
* @param credentials User credentials (optional)
* @param curUserPattern Index into userPatternFormatArray
- *
+ * @return the User object
* @exception NamingException if a directory server error occurs
*/
protected User getUser(DirContext context, String username,
@@ -1546,7 +1550,7 @@ public class JNDIRealm extends RealmBase
* @param attrIds String[]containing names of attributes to
* @param dn Distinguished name of the user
* retrieve.
- *
+ * @return the User object
* @exception NamingException if a directory server error occurs
*/
protected User getUserByPattern(DirContext context,
@@ -1600,7 +1604,7 @@ public class JNDIRealm extends RealmBase
* @param credentials User credentials (optional)
* @param attrIds String[]containing names of attributes to
* @param curUserPattern Index into userPatternFormatArray
- *
+ * @return the User object
* @exception NamingException if a directory server error occurs
* @see #getUserByPattern(DirContext, String, String[], String)
*/
@@ -1646,7 +1650,7 @@ public class JNDIRealm extends RealmBase
* @param context The directory context
* @param username The username
* @param attrIds String[]containing names of attributes to retrieve.
- *
+ * @return the User object
* @exception NamingException if a directory server error occurs
*/
protected User getUserBySearch(DirContext context,
@@ -1750,7 +1754,7 @@ public class JNDIRealm extends RealmBase
* @param context The directory context
* @param user The User to be authenticated
* @param credentials The credentials presented by the user
- *
+ * @return <code>true</code> if the credentials are validated
* @exception NamingException if a directory server error occurs
*/
protected boolean checkCredentials(DirContext context,
@@ -1786,7 +1790,7 @@ public class JNDIRealm extends RealmBase
* @param context The directory context
* @param info The User to be authenticated
* @param credentials Authentication credentials
- *
+ * @return <code>true</code> if the credentials are validated
* @exception NamingException if a directory server error occurs
*/
protected boolean compareCredentials(DirContext context,
@@ -1813,7 +1817,7 @@ public class JNDIRealm extends RealmBase
* @param context The directory context
* @param user The User to be authenticated
* @param credentials Authentication credentials
- *
+ * @return <code>true</code> if the credentials are validated
* @exception NamingException if a directory server error occurs
*/
protected boolean bindAsUser(DirContext context,
@@ -1862,6 +1866,7 @@ public class JNDIRealm extends RealmBase
* @param context DirContext to configure
* @param dn Distinguished name of user
* @param credentials Credentials of user
+ * @exception NamingException if a directory server error occurs
*/
private void userCredentialsAdd(DirContext context, String dn,
String credentials) throws NamingException {
@@ -1876,6 +1881,7 @@ public class JNDIRealm extends RealmBase
* those attributes are not specified.
*
* @param context DirContext to configure
+ * @exception NamingException if a directory server error occurs
*/
private void userCredentialsRemove(DirContext context)
throws NamingException {
@@ -1904,7 +1910,7 @@ public class JNDIRealm extends RealmBase
*
* @param context The directory context we are searching
* @param user The User to be checked
- *
+ * @return the list of role names
* @exception NamingException if a directory server error occurs
*/
protected List<String> getRoles(DirContext context, User user)
@@ -2065,7 +2071,7 @@ public class JNDIRealm extends RealmBase
*
* @param attrId Attribute name
* @param attrs Attributes containing the required value
- *
+ * @return the attribute value
* @exception NamingException if a directory server error occurs
*/
private String getAttributeValue(String attrId, Attributes attrs)
@@ -2099,7 +2105,7 @@ public class JNDIRealm extends RealmBase
* @param attrId Attribute name
* @param attrs Attributes containing the new values
* @param values ArrayList containing values found so far
- *
+ * @return the list of attribute values
* @exception NamingException if a directory server error occurs
*/
private ArrayList<String> addAttributeValues(String attrId,
@@ -2163,7 +2169,7 @@ public class JNDIRealm extends RealmBase
/**
- * Return a short name for this Realm implementation.
+ * @return a short name for this Realm implementation.
*/
@Override
protected String getName() {
@@ -2174,7 +2180,9 @@ public class JNDIRealm extends RealmBase
/**
- * Return the password associated with the given principal's user name.
+ * Get the password for the specified user.
+ * @param username The user name
+ * @return the password associated with the given principal's user name.
*/
@Override
protected String getPassword(String username) {
@@ -2199,7 +2207,9 @@ public class JNDIRealm extends RealmBase
}
/**
- * Return the Principal associated with the given user name.
+ * Get the principal associated with the specified certificate.
+ * @param username The user name
+ * @return the Principal associated with the given certificate.
*/
@Override
protected Principal getPrincipal(String username) {
@@ -2283,7 +2293,12 @@ public class JNDIRealm extends RealmBase
/**
- * Return the Principal associated with the given user name.
+ * Get the principal associated with the specified certificate.
+ * @param context The directory context
+ * @param username The user name
+ * @param gssCredential The credentials
+ * @return the Principal associated with the given certificate.
+ * @exception NamingException if a directory server error occurs
*/
protected synchronized Principal getPrincipal(DirContext context,
String username, GSSCredential gssCredential)
@@ -2344,7 +2359,7 @@ public class JNDIRealm extends RealmBase
/**
* Open (if necessary) and return a connection to the configured
* directory server for this Realm.
- *
+ * @return the directory context
* @exception NamingException if a directory server error occurs
*/
protected DirContext open() throws NamingException {
@@ -2596,6 +2611,7 @@ public class JNDIRealm extends RealmBase
*
* @param userPatternString - a string LDAP search paths surrounded by
* parentheses
+ * @return a parsed string array
*/
protected String[] parseUserPatternString(String userPatternString) {
@@ -2684,6 +2700,7 @@ public class JNDIRealm extends RealmBase
* @param base The base DN
* @param result The search result
* @return String containing the distinguished name
+ * @exception NamingException if a directory server error occurs
*/
protected String getDistinguishedName(DirContext context, String base,
SearchResult result) throws NamingException {
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org