SchemaRequestMessage.java
01 /*
02  *
03  * Licensed to the Apache Software Foundation (ASF) under one
04  * or more contributor license agreements.  See the NOTICE file
05  * distributed with this work for additional information
06  * regarding copyright ownership.  The ASF licenses this file
07  * to you under the Apache License, Version 2.0 (the
08  * "License"); you may not use this file except in compliance
09  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  */
21 package org.apache.qpid.management.messages;
22 
23 import org.apache.qpid.management.Protocol;
24 import org.apache.qpid.management.domain.model.type.Binary;
25 
26 /**
27  * Abstract representation of a schema request message.
28  * Concrete subclasses must supply the values needed to build & encode the message.
29  
30  @author Andrea Gazzarini
31  */
32 public abstract class SchemaRequestMessage extends ManagementMessage
33 {
34     @Override
35     char opcode ()
36     {
37         return Protocol.SCHEMA_REQUEST_OPCODE;
38     }
39     
40     /**
41      * Returns the package name.
42      
43      @return the package name.
44      */
45     protected abstract String packageName();
46     
47     /**
48      * Returns the class name.
49      
50      @return the class name.
51      */
52     protected abstract String className();
53     
54     /**
55      * Returns the schema hash.
56      
57      @return the schema hash.
58      */
59     protected abstract Binary schemaHash();
60 
61     @Override
62     final void specificMessageEncoding ()
63     {
64       _codec.writeStr8(packageName());
65       _codec.writeStr8(className());
66         schemaHash().encode(_codec);
67     }
68 }