001    /* 
002        Licensed to the Apache Software Foundation (ASF) under one
003        or more contributor license agreements.  See the NOTICE file
004        distributed with this work for additional information
005        regarding copyright ownership.  The ASF licenses this file
006        to you under the Apache License, Version 2.0 (the
007        "License"); you may not use this file except in compliance
008        with the License.  You may obtain a copy of the License at
009    
010           http://www.apache.org/licenses/LICENSE-2.0
011    
012        Unless required by applicable law or agreed to in writing,
013        software distributed under the License is distributed on an
014        "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015        KIND, either express or implied.  See the License for the
016        specific language governing permissions and limitations
017        under the License.  
018     */
019    package org.apache.wiki.rpc;
020    
021    /**
022     *  A base class for managing RPC calls.
023     *  
024     *  @since 2.5.4
025     */
026    public class RPCManager
027    {
028        /**
029         *  Private constructor to prevent initialization.
030         */
031        protected RPCManager() {}
032        
033        /**
034         *  Gets an unique RPC ID for a callable object.  This is required because a plugin
035         *  does not know how many times it is already been invoked.
036         *  <p>
037         *  The id returned contains only upper and lower ASCII characters and digits, and
038         *  it always starts with an ASCII character.  Therefore the id is suitable as a
039         *  programming language construct directly (e.g. object name).
040         *  
041         *  @param c An RPCCallable
042         *  @return An unique id for the callable.
043         */
044        public static String getId( RPCCallable c )
045        {
046            return "RPC"+c.hashCode();
047        }
048        
049    
050    }