This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch 2.2.X in repository https://gitbox.apache.org/repos/asf/mina.git
The following commit(s) were added to refs/heads/2.2.X by this push: new be5886c6f Javadoc: Port package.html to package-info.java be5886c6f is described below commit be5886c6f6f3df52b92391d81ba321c082933d9d Author: Gary Gregory <ggreg...@rocketsoftware.com> AuthorDate: Sun Mar 19 16:49:25 2023 -0400 Javadoc: Port package.html to package-info.java - Fix spelling - Fix HTML headers --- .../mina/example/chat/client/package-info.java | 24 ++++++ .../apache/mina/example/chat/client/package.html | 24 ------ .../org/apache/mina/example/chat/package-info.java | 24 ++++++ .../java/org/apache/mina/example/chat/package.html | 24 ------ .../mina/example/echoserver/package-info.java | 24 ++++++ .../apache/mina/example/echoserver/package.html | 24 ------ .../mina/example/echoserver/ssl/package-info.java | 24 ++++++ .../mina/example/echoserver/ssl/package.html | 24 ------ .../apache/mina/example/netcat/package-info.java | 24 ++++++ .../org/apache/mina/example/netcat/package.html | 25 ------ .../apache/mina/example/proxy/package-info.java | 24 ++++++ .../org/apache/mina/example/proxy/package.html | 25 ------ .../apache/mina/example/reverser/package-info.java | 24 ++++++ .../org/apache/mina/example/reverser/package.html | 25 ------ .../mina/example/sumup/codec/package-info.java | 24 ++++++ .../apache/mina/example/sumup/codec/package.html | 25 ------ .../mina/example/sumup/message/package-info.java | 24 ++++++ .../apache/mina/example/sumup/message/package.html | 25 ------ .../apache/mina/example/sumup/package-info.java | 24 ++++++ .../org/apache/mina/example/sumup/package.html | 25 ------ .../apache/mina/example/tennis/package-info.java | 24 ++++++ .../org/apache/mina/example/tennis/package.html | 24 ------ .../apache/mina/integration/jmx/package-info.java | 82 ++++++++++++++++++++ .../org/apache/mina/integration/jmx/package.html | 88 ---------------------- 24 files changed, 346 insertions(+), 358 deletions(-) diff --git a/mina-example/src/main/java/org/apache/mina/example/chat/client/package-info.java b/mina-example/src/main/java/org/apache/mina/example/chat/client/package-info.java new file mode 100644 index 000000000..ce5fe522e --- /dev/null +++ b/mina-example/src/main/java/org/apache/mina/example/chat/client/package-info.java @@ -0,0 +1,24 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + */ + +/** + * Swing based chat client. + */ +package org.apache.mina.example.chat.client; diff --git a/mina-example/src/main/java/org/apache/mina/example/chat/client/package.html b/mina-example/src/main/java/org/apache/mina/example/chat/client/package.html deleted file mode 100644 index ecc535371..000000000 --- a/mina-example/src/main/java/org/apache/mina/example/chat/client/package.html +++ /dev/null @@ -1,24 +0,0 @@ -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> -</head> -<body> -Swing based chat client. -</body> -</html> diff --git a/mina-example/src/main/java/org/apache/mina/example/chat/package-info.java b/mina-example/src/main/java/org/apache/mina/example/chat/package-info.java new file mode 100644 index 000000000..121c77633 --- /dev/null +++ b/mina-example/src/main/java/org/apache/mina/example/chat/package-info.java @@ -0,0 +1,24 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + */ + +/** + * Chat server which demonstates using the text line codec and Spring integration. + */ +package org.apache.mina.example.chat; diff --git a/mina-example/src/main/java/org/apache/mina/example/chat/package.html b/mina-example/src/main/java/org/apache/mina/example/chat/package.html deleted file mode 100644 index f742579e0..000000000 --- a/mina-example/src/main/java/org/apache/mina/example/chat/package.html +++ /dev/null @@ -1,24 +0,0 @@ -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> -</head> -<body> -Chat server which demonstates using the text line codec and Spring integration. -</body> -</html> diff --git a/mina-example/src/main/java/org/apache/mina/example/echoserver/package-info.java b/mina-example/src/main/java/org/apache/mina/example/echoserver/package-info.java new file mode 100644 index 000000000..414e4bb44 --- /dev/null +++ b/mina-example/src/main/java/org/apache/mina/example/echoserver/package-info.java @@ -0,0 +1,24 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + */ + +/** + * Echo server which demonstrates low-level I/O layer and SSL support. + */ +package org.apache.mina.example.echoserver; diff --git a/mina-example/src/main/java/org/apache/mina/example/echoserver/package.html b/mina-example/src/main/java/org/apache/mina/example/echoserver/package.html deleted file mode 100644 index 92d5d470a..000000000 --- a/mina-example/src/main/java/org/apache/mina/example/echoserver/package.html +++ /dev/null @@ -1,24 +0,0 @@ -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> -</head> -<body> -Echo server which demonstates low-level I/O layer and SSL support. -</body> -</html> diff --git a/mina-example/src/main/java/org/apache/mina/example/echoserver/ssl/package-info.java b/mina-example/src/main/java/org/apache/mina/example/echoserver/ssl/package-info.java new file mode 100644 index 000000000..889524acf --- /dev/null +++ b/mina-example/src/main/java/org/apache/mina/example/echoserver/ssl/package-info.java @@ -0,0 +1,24 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + */ + +/** + * SSL support classes. + */ +package org.apache.mina.example.echoserver.ssl; diff --git a/mina-example/src/main/java/org/apache/mina/example/echoserver/ssl/package.html b/mina-example/src/main/java/org/apache/mina/example/echoserver/ssl/package.html deleted file mode 100644 index 7bc6b5448..000000000 --- a/mina-example/src/main/java/org/apache/mina/example/echoserver/ssl/package.html +++ /dev/null @@ -1,24 +0,0 @@ -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> -</head> -<body> -SSL support classes. -</body> -</html> diff --git a/mina-example/src/main/java/org/apache/mina/example/netcat/package-info.java b/mina-example/src/main/java/org/apache/mina/example/netcat/package-info.java new file mode 100644 index 000000000..8ddd47ed7 --- /dev/null +++ b/mina-example/src/main/java/org/apache/mina/example/netcat/package-info.java @@ -0,0 +1,24 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + */ + +/** + * NetCat client (Network + Unix <code>cat</code> command) which demonstrates low-level I/O layer. + */ +package org.apache.mina.example.netcat; diff --git a/mina-example/src/main/java/org/apache/mina/example/netcat/package.html b/mina-example/src/main/java/org/apache/mina/example/netcat/package.html deleted file mode 100644 index 849160b02..000000000 --- a/mina-example/src/main/java/org/apache/mina/example/netcat/package.html +++ /dev/null @@ -1,25 +0,0 @@ -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> -</head> -<body> -NetCat client (Network + Unix <code>cat</code> command) which demonstates low-level I/O layer. -</body> -</body> -</html> diff --git a/mina-example/src/main/java/org/apache/mina/example/proxy/package-info.java b/mina-example/src/main/java/org/apache/mina/example/proxy/package-info.java new file mode 100644 index 000000000..43942483c --- /dev/null +++ b/mina-example/src/main/java/org/apache/mina/example/proxy/package-info.java @@ -0,0 +1,24 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + */ + +/** + * A TCP/IP tunneling proxy example. + */ +package org.apache.mina.example.proxy; diff --git a/mina-example/src/main/java/org/apache/mina/example/proxy/package.html b/mina-example/src/main/java/org/apache/mina/example/proxy/package.html deleted file mode 100644 index c322906de..000000000 --- a/mina-example/src/main/java/org/apache/mina/example/proxy/package.html +++ /dev/null @@ -1,25 +0,0 @@ -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> -</head> -<body> -A TCP/IP tunneling proxy example. -</body> -</body> -</html> diff --git a/mina-example/src/main/java/org/apache/mina/example/reverser/package-info.java b/mina-example/src/main/java/org/apache/mina/example/reverser/package-info.java new file mode 100644 index 000000000..0008f0ace --- /dev/null +++ b/mina-example/src/main/java/org/apache/mina/example/reverser/package-info.java @@ -0,0 +1,24 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + */ + +/** + * Reverser server which reverses all text lines demonstrating high-level protocol layer. + */ +package org.apache.mina.example.reverser; diff --git a/mina-example/src/main/java/org/apache/mina/example/reverser/package.html b/mina-example/src/main/java/org/apache/mina/example/reverser/package.html deleted file mode 100644 index db3f77089..000000000 --- a/mina-example/src/main/java/org/apache/mina/example/reverser/package.html +++ /dev/null @@ -1,25 +0,0 @@ -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> -</head> -<body> -Reverser server which reverses all text lines demonstating high-level protocol layer. -</body> -</body> -</html> diff --git a/mina-example/src/main/java/org/apache/mina/example/sumup/codec/package-info.java b/mina-example/src/main/java/org/apache/mina/example/sumup/codec/package-info.java new file mode 100644 index 000000000..cd23a4530 --- /dev/null +++ b/mina-example/src/main/java/org/apache/mina/example/sumup/codec/package-info.java @@ -0,0 +1,24 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + */ + +/** + * Protocol codec implementation for SumUp protocol. + */ +package org.apache.mina.example.sumup.codec; diff --git a/mina-example/src/main/java/org/apache/mina/example/sumup/codec/package.html b/mina-example/src/main/java/org/apache/mina/example/sumup/codec/package.html deleted file mode 100644 index 3189489a3..000000000 --- a/mina-example/src/main/java/org/apache/mina/example/sumup/codec/package.html +++ /dev/null @@ -1,25 +0,0 @@ -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> -</head> -<body> -Protocol codec implementation for SumUp protocol. -</body> -</body> -</html> diff --git a/mina-example/src/main/java/org/apache/mina/example/sumup/message/package-info.java b/mina-example/src/main/java/org/apache/mina/example/sumup/message/package-info.java new file mode 100644 index 000000000..fe2d9491c --- /dev/null +++ b/mina-example/src/main/java/org/apache/mina/example/sumup/message/package-info.java @@ -0,0 +1,24 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + */ + +/** + * Protocol message classes for SumUp protocol. + */ +package org.apache.mina.example.sumup.message; diff --git a/mina-example/src/main/java/org/apache/mina/example/sumup/message/package.html b/mina-example/src/main/java/org/apache/mina/example/sumup/message/package.html deleted file mode 100644 index b12e92ae8..000000000 --- a/mina-example/src/main/java/org/apache/mina/example/sumup/message/package.html +++ /dev/null @@ -1,25 +0,0 @@ -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> -</head> -<body> -Protocol mmessage classes for SumUp protocol. -</body> -</body> -</html> diff --git a/mina-example/src/main/java/org/apache/mina/example/sumup/package-info.java b/mina-example/src/main/java/org/apache/mina/example/sumup/package-info.java new file mode 100644 index 000000000..52bd8382d --- /dev/null +++ b/mina-example/src/main/java/org/apache/mina/example/sumup/package-info.java @@ -0,0 +1,24 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + */ + +/** + * SumUp Server and Client which sums up all ADD requests. + */ +package org.apache.mina.example.sumup; diff --git a/mina-example/src/main/java/org/apache/mina/example/sumup/package.html b/mina-example/src/main/java/org/apache/mina/example/sumup/package.html deleted file mode 100644 index 2fe98d483..000000000 --- a/mina-example/src/main/java/org/apache/mina/example/sumup/package.html +++ /dev/null @@ -1,25 +0,0 @@ -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> -</head> -<body> -SumUp Server and Client which sums up all ADD requests. -</body> -</body> -</html> diff --git a/mina-example/src/main/java/org/apache/mina/example/tennis/package-info.java b/mina-example/src/main/java/org/apache/mina/example/tennis/package-info.java new file mode 100644 index 000000000..d6bc4cc5a --- /dev/null +++ b/mina-example/src/main/java/org/apache/mina/example/tennis/package-info.java @@ -0,0 +1,24 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + */ + +/** + * Two tennis players play a game which demonstrates in-VM pipes. + */ +package org.apache.mina.example.tennis; diff --git a/mina-example/src/main/java/org/apache/mina/example/tennis/package.html b/mina-example/src/main/java/org/apache/mina/example/tennis/package.html deleted file mode 100644 index ef7497744..000000000 --- a/mina-example/src/main/java/org/apache/mina/example/tennis/package.html +++ /dev/null @@ -1,24 +0,0 @@ -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> -</head> -<body> -Two tennis players play a game which demonstates in-VM pipes. -</body> -</html> diff --git a/mina-integration-jmx/src/main/java/org/apache/mina/integration/jmx/package-info.java b/mina-integration-jmx/src/main/java/org/apache/mina/integration/jmx/package-info.java new file mode 100644 index 000000000..f4ba667cb --- /dev/null +++ b/mina-integration-jmx/src/main/java/org/apache/mina/integration/jmx/package-info.java @@ -0,0 +1,82 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + */ + +/** + * JMX (Java Management eXtension) integration. + * <h2>Monitoring Your MINA Services and Sessions</h2> + * <h3>Monitoring an IoService</h3> + * <pre>{@code + * acceptor = new SocketAcceptor(); + * + * try + * { + * IoServiceManager iosm = new IoServiceManager(acceptor); + * MBeanServer mbs = ManagementFactory.getPlatformMBeanServer(); + * ObjectName name = new ObjectName( "com.acme.test:type=IoServiceManager,name=MyMINAServer" ); + * mbs.registerMBean( iosm, name ); + * } + * catch( JMException e ) + * { + * logger.error( "JMX Exception: ", e ); + * } + * }</pre> + * <h3>Monitoring an IoSession</h3> + * Each session is registered to MBean server individually. + * <pre> + * acceptor.addListener( new IoServiceListener() + * { + * public void serviceActivated( IoService service, SocketAddress serviceAddress, IoHandler handler, IoServiceConfig config ) + * { + * } + * + * public void serviceDeactivated( IoService service, SocketAddress serviceAddress, IoHandler handler, IoServiceConfig config ) + * { + * } + * + * public void sessionCreated( IoSession session ) + * { + * try + * { + * IoSessionManager sessMgr = new IoSessionManager( session ); + * MBeanServer mbs = ManagementFactory.getPlatformMBeanServer(); + * ObjectName name = new ObjectName( "com.acme.test.session:type=IoSessionManager,name=" + session.getRemoteAddress().toString().replace( ':', '/' ) ); + * mbs.registerMBean( sessMgr, name ); + * } + * catch( JMException e ) + * { + * logger.error( "JMX Exception: ", e ); + * } + * } + * public void sessionDestroyed( IoSession session ) + * { + * try + * { + * ObjectName name = new ObjectName( "com.acme.test.session:type=IoSessionManager,name=" + session.getRemoteAddress().toString().replace( ':', '/' ) ); + * ManagementFactory.getPlatformMBeanServer().unregisterMBean( name ); + * } + * catch( JMException e ) + * { + * logger.error( "JMX Exception: ", e ); + * } + * } + * }); + * }</pre> + */ +package org.apache.mina.integration.jmx; diff --git a/mina-integration-jmx/src/main/java/org/apache/mina/integration/jmx/package.html b/mina-integration-jmx/src/main/java/org/apache/mina/integration/jmx/package.html deleted file mode 100644 index 026ad6e7a..000000000 --- a/mina-integration-jmx/src/main/java/org/apache/mina/integration/jmx/package.html +++ /dev/null @@ -1,88 +0,0 @@ -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> -</head> -<body> -JMX (Java Management eXtension) integration. - -<h2>Monitoring Your MINA Services and Sessions</h3> - -<h3>Monitoring an IoService</h3> -<pre> -acceptor = new SocketAcceptor(); - -try -{ - IoServiceManager iosm = new IoServiceManager(acceptor); - MBeanServer mbs = ManagementFactory.getPlatformMBeanServer(); - ObjectName name = new ObjectName( "com.acme.test:type=IoServiceManager,name=MyMINAServer" ); - mbs.registerMBean( iosm, name ); -} -catch( JMException e ) -{ - logger.error( "JMX Exception: ", e ); -} -</pre> - -<h3>Monitoring an IoSession</h3> - -Each session is registered to MBean server individually. - -<pre> -acceptor.addListener( new IoServiceListener() -{ - public void serviceActivated( IoService service, SocketAddress serviceAddress, IoHandler handler, IoServiceConfig config ) - { - } - - public void serviceDeactivated( IoService service, SocketAddress serviceAddress, IoHandler handler, IoServiceConfig config ) - { - } - - public void sessionCreated( IoSession session ) - { - try - { - IoSessionManager sessMgr = new IoSessionManager( session ); - MBeanServer mbs = ManagementFactory.getPlatformMBeanServer(); - ObjectName name = new ObjectName( "com.acme.test.session:type=IoSessionManager,name=" + session.getRemoteAddress().toString().replace( ':', '/' ) ); - mbs.registerMBean( sessMgr, name ); - } - catch( JMException e ) - { - logger.error( "JMX Exception: ", e ); - } - } - - public void sessionDestroyed( IoSession session ) - { - try - { - ObjectName name = new ObjectName( "com.acme.test.session:type=IoSessionManager,name=" + session.getRemoteAddress().toString().replace( ':', '/' ) ); - ManagementFactory.getPlatformMBeanServer().unregisterMBean( name ); - } - catch( JMException e ) - { - logger.error( "JMX Exception: ", e ); - } - } -}); -</pre> -</body> -</html>