com.paremus.dosgi.net.wireformat.Protocol_V1 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.paremus.dosgi.net Show documentation
An implementation of OSGi Remote Service Admin, enhanced to provide support for OSGi Promises and streaming using OSGi PushStreams.
The newest version!
/*-
 * #%L
 * com.paremus.dosgi.net
 * %%
 * Copyright (C) 2016 - 2019 Paremus Ltd
 * %%
 * Licensed under the Fair Source License, Version 0.9 (the "License");
 * 
 * See the NOTICE.txt file distributed with this work for additional 
 * information regarding copyright ownership. You may not use this file 
 * except in compliance with the License. For usage restrictions see the 
 * LICENSE.txt file distributed with this work
 * #L%
 */
package com.paremus.dosgi.net.wireformat;

import java.lang.reflect.Method;

public class Protocol_V1 {

	public static final byte VERSION = 1;
	
	/** 
	 * The standard message header format is as follows:
	 * byte 0  |    byte 1-3    | byte 4  | long, long |   int   |
	 * Version | message length | Command | Service ID | Call ID |
	 * 
	 */
	
	/** Commands */
	
	/** 
	 * Format: | Header | method index short | serialized args | 
	 *
	 * Usage - sent by client to indicate a method call with an expectation of a return value
	 */
	public static final byte CALL_WITH_RETURN = 1;
	
	/** 
	 * Format: | Header | method index short | serialized args | 
	 *
	 * Usage - sent by client to indicate a method call with no expectation of a return value
	 */
	public static final byte CALL_WITHOUT_RETURN = 2;
	
	/** 
	 * Format: | Header | interrupt boolean |
	 *
	 * Usage - sent by client to cancel a method call. The boolean represents whether the caller
	 * should be interrupted.
	 */
	public static final byte CANCEL = 3;
	
	/** 
	 * Format: | Header | serialized response | 
	 *
	 * Usage - sent by server to indicate a successful return value. Multiple
	 * responses for the same method call may occur if the response is a Streaming
	 * response.
	 */
	public static final byte SUCCESS_RESPONSE = 4;
	
	/** 
	 * Format: | Header | serialized failure | 
	 *
	 * Usage - sent by server to indicate a failure including the exception
	 */
	public static final byte FAILURE_RESPONSE = 5;
	
	/** 
	 * Format: | Header |
	 *
	 * Usage - sent by server to indicate no service existed for the requested id
	 */
	public static final byte FAILURE_NO_SERVICE = 6;
	
	/** 
	 * Format: | Header |
	 *
	 * Usage - sent by server to indicate no method with the supplied id existed
	 * on the identified service 
	 */
	public static final byte FAILURE_NO_METHOD = 7;
	
	/** 
	 * Format: | Header | String message |
	 *
	 * Usage - sent by server to indicate that a deserialization error occurred
	 * when processing the arguments
	 */
	public static final byte FAILURE_TO_DESERIALIZE = 8;
	
	/** 
	 * Format: | Header | Message
	 *
	 * Usage - sent by server to indicate that the success response could not be serialized
	 */
	public static final byte FAILURE_TO_SERIALIZE_SUCCESS = 9;
	
	/** 
	 * Format: | Header | Message
	 *
	 * Usage - sent by server to indicate that the failure response could not be serialized
	 */
	public static final byte FAILURE_TO_SERIALIZE_FAILURE = 10;
	
	
	/** 
	 * Format: | Header | String message |
	 *
	 * Usage - sent by server to indicate that no more requests can be processed at this time
	 */
	public static final byte FAILURE_SERVER_OVERLOADED = 11;
	
	/** 
	 * Format: | Header | String message
	 *
	 * Usage - sent by server to indicate an unknown failure occurred
	 */
	public static final byte FAILURE_UNKNOWN = 12;
	
	/**
	 * Converts a java.lang.reflect.Method into a canonicalised String
	 * 
	 * @param m the method
	 * @return A string identifier for the method
	 */
	public static String toSignature(Method m) {
		StringBuilder sb = new StringBuilder(m.getName());
    	sb.append('[');
    	boolean hasParameters = false;
    	for(Class clazz : m.getParameterTypes()) {
    		sb.append(clazz.getName()).append(",");
    		hasParameters = true;
    	}
    	if(hasParameters) {
    		sb.deleteCharAt(sb.length() - 1);
    	}
    	return sb.append(']').toString();
	}

    /**
     * The width (in bytes) of the size field in the RSA messages.
     * This field is unsigned.
     */
	public static final int SIZE_WIDTH_IN_BYTES = 3;
}