├── .travis.yml ├── CONTRIBUTORS.md ├── src ├── main │ └── java │ │ └── com │ │ └── github │ │ └── edouardswiac │ │ └── zerotier │ │ ├── api │ │ ├── ZTCRelay.java │ │ ├── ZTCAssignment.java │ │ ├── ZTController.java │ │ ├── ZTCRule.java │ │ ├── ZTNetworkConfig.java │ │ ├── ZTNetworkMember.java │ │ ├── ZTStatus.java │ │ ├── ZTNetworkMemberConfig.java │ │ ├── ZTNetwork.java │ │ ├── ZTCMember.java │ │ └── ZTCNetwork.java │ │ ├── exceptions │ │ ├── ZTClientException.java │ │ └── ZTServiceException.java │ │ ├── interceptors │ │ ├── UserAgentInterceptor.java │ │ ├── AuthenticationInterceptor.java │ │ └── LoggingInterceptor.java │ │ ├── ZTService.java │ │ └── ZTServiceImpl.java └── test │ └── java │ └── com │ └── github │ └── edouardswiac │ └── zerotier │ └── ZTServiceTest.java ├── .gitignore ├── README.md ├── pom.xml └── LICENSE /.travis.yml: -------------------------------------------------------------------------------- 1 | language: java 2 | jdk: 3 | - oraclejdk8 4 | - oraclejdk7 5 | -------------------------------------------------------------------------------- /CONTRIBUTORS.md: -------------------------------------------------------------------------------- 1 | [Edouard Swiac] (https://github.com/edouardswiac) 2 | - Project creator / first commit 3 | -------------------------------------------------------------------------------- /src/main/java/com/github/edouardswiac/zerotier/api/ZTCRelay.java: -------------------------------------------------------------------------------- 1 | package com.github.edouardswiac.zerotier.api; 2 | 3 | public final class ZTCRelay { 4 | String address; 5 | String phyAddress; 6 | 7 | public String getAddress() { 8 | return address; 9 | } 10 | 11 | public String getPhyAddress() { 12 | return phyAddress; 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.class 2 | 3 | # Mobile Tools for Java (J2ME) 4 | .mtj.tmp/ 5 | 6 | # Package Files # 7 | *.jar 8 | *.war 9 | *.ear 10 | 11 | target/* 12 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 13 | hs_err_pid* 14 | 15 | # intelliJ 16 | *.idea 17 | *.iml 18 | /bin/ 19 | /target/ 20 | /.settings/ 21 | /.classpath 22 | /.project 23 | -------------------------------------------------------------------------------- /src/main/java/com/github/edouardswiac/zerotier/api/ZTCAssignment.java: -------------------------------------------------------------------------------- 1 | package com.github.edouardswiac.zerotier.api; 2 | 3 | public final class ZTCAssignment { 4 | String ipRangeStart; 5 | String ipRangeEnd; 6 | 7 | public String getIpRangeStart() { 8 | return ipRangeStart; 9 | } 10 | 11 | public String getIpRangeEnd() { 12 | return ipRangeEnd; 13 | } 14 | 15 | } 16 | -------------------------------------------------------------------------------- /src/main/java/com/github/edouardswiac/zerotier/exceptions/ZTClientException.java: -------------------------------------------------------------------------------- 1 | package com.github.edouardswiac.zerotier.exceptions; 2 | 3 | 4 | public final class ZTClientException extends RuntimeException { 5 | private static final long serialVersionUID = 1L; 6 | 7 | public ZTClientException() { 8 | super(); 9 | } 10 | 11 | public ZTClientException(String message) { 12 | super(message); 13 | } 14 | 15 | public ZTClientException(String message, Throwable cause) { 16 | super(message, cause); 17 | } 18 | 19 | public ZTClientException(Throwable cause) { 20 | super(cause); 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /src/main/java/com/github/edouardswiac/zerotier/exceptions/ZTServiceException.java: -------------------------------------------------------------------------------- 1 | package com.github.edouardswiac.zerotier.exceptions; 2 | 3 | 4 | public final class ZTServiceException extends RuntimeException { 5 | private static final long serialVersionUID = 1L; 6 | 7 | public ZTServiceException(Throwable cause) { 8 | super(cause); 9 | } 10 | 11 | public ZTServiceException() { 12 | super(); 13 | } 14 | 15 | public ZTServiceException(String message) { 16 | super(message); 17 | } 18 | 19 | public ZTServiceException(String message, Throwable cause) { 20 | super(message, cause); 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /src/main/java/com/github/edouardswiac/zerotier/interceptors/UserAgentInterceptor.java: -------------------------------------------------------------------------------- 1 | package com.github.edouardswiac.zerotier.interceptors; 2 | 3 | 4 | import com.squareup.okhttp.Interceptor; 5 | import com.squareup.okhttp.Request; 6 | import com.squareup.okhttp.Response; 7 | 8 | import java.io.IOException; 9 | 10 | public final class UserAgentInterceptor implements Interceptor { 11 | 12 | private final String userAgent; 13 | 14 | public UserAgentInterceptor(String userAgent) { 15 | this.userAgent = userAgent; 16 | } 17 | 18 | @Override 19 | public Response intercept(Chain chain) throws IOException { 20 | Request originalRequest = chain.request(); 21 | Request requestWithUserAgent = originalRequest.newBuilder() 22 | .removeHeader("User-Agent") 23 | .addHeader("User-Agent", userAgent) 24 | .build(); 25 | return chain.proceed(requestWithUserAgent); 26 | } 27 | } -------------------------------------------------------------------------------- /src/main/java/com/github/edouardswiac/zerotier/api/ZTController.java: -------------------------------------------------------------------------------- 1 | package com.github.edouardswiac.zerotier.api; 2 | 3 | 4 | public final class ZTController { 5 | private Boolean controller; 6 | private int apiVersion; 7 | private long clock; 8 | private String instanceId; 9 | 10 | public ZTController() { 11 | } 12 | 13 | public Boolean getController() { 14 | return controller; 15 | } 16 | 17 | public int getApiVersion() { 18 | return apiVersion; 19 | } 20 | 21 | public long getClock() { 22 | return clock; 23 | } 24 | 25 | public String getInstanceId() { 26 | return instanceId; 27 | } 28 | 29 | @Override 30 | public String toString() { 31 | final StringBuffer sb = new StringBuffer("ZTController{"); 32 | sb.append("controller=").append(controller); 33 | sb.append(", apiVersion='").append(apiVersion).append('\''); 34 | sb.append(", instanceId='").append(instanceId).append('\''); 35 | sb.append('}'); 36 | return sb.toString(); 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /src/main/java/com/github/edouardswiac/zerotier/interceptors/AuthenticationInterceptor.java: -------------------------------------------------------------------------------- 1 | package com.github.edouardswiac.zerotier.interceptors; 2 | 3 | 4 | import com.squareup.okhttp.Interceptor; 5 | import com.squareup.okhttp.Request; 6 | import com.squareup.okhttp.Response; 7 | 8 | import java.io.IOException; 9 | 10 | public final class AuthenticationInterceptor implements Interceptor { 11 | private final String apiAccessToken; 12 | 13 | public AuthenticationInterceptor(String apiAccessToken) { 14 | this.apiAccessToken = apiAccessToken; 15 | } 16 | 17 | @Override 18 | public Response intercept(Chain chain) throws IOException { 19 | Request originalRequest = chain.request(); 20 | if (null == apiAccessToken || apiAccessToken.isEmpty()) { 21 | return chain.proceed(originalRequest); 22 | } 23 | 24 | Request requestWithUserAgent = originalRequest.newBuilder() 25 | .addHeader("Authorization", String.format("Bearer %s", apiAccessToken)) 26 | .addHeader("X-ZT1-Auth", apiAccessToken) 27 | .build(); 28 | return chain.proceed(requestWithUserAgent); 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /src/main/java/com/github/edouardswiac/zerotier/interceptors/LoggingInterceptor.java: -------------------------------------------------------------------------------- 1 | package com.github.edouardswiac.zerotier.interceptors; 2 | 3 | 4 | import com.squareup.okhttp.Interceptor; 5 | import com.squareup.okhttp.Request; 6 | import com.squareup.okhttp.Response; 7 | import okio.Buffer; 8 | import org.slf4j.Logger; 9 | 10 | import java.io.IOException; 11 | 12 | public final class LoggingInterceptor implements Interceptor { 13 | public final Logger log; 14 | 15 | public LoggingInterceptor(Logger logger) { 16 | log = logger; 17 | } 18 | @Override 19 | public Response intercept(Chain chain) throws IOException { 20 | Request request = chain.request(); 21 | 22 | long t1 = System.nanoTime(); 23 | log.info(String.format("Sending %s %s", request.method(), request.url())); 24 | 25 | if (request.body() != null) { 26 | final Request reqCopy = request.newBuilder().build(); 27 | final Buffer reqCopyBuffer = new Buffer(); 28 | reqCopy.body().writeTo(reqCopyBuffer); 29 | log.info("body: {}", reqCopyBuffer.readUtf8()); 30 | } 31 | 32 | Response response = chain.proceed(request); 33 | 34 | long t2 = System.nanoTime(); 35 | log.info(String.format("Received HTTP %s for %s in %.1fms%n", response.code(), 36 | response.request().url(), (t2 - t1) / 1e6d)); 37 | 38 | return response; 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /src/main/java/com/github/edouardswiac/zerotier/api/ZTCRule.java: -------------------------------------------------------------------------------- 1 | package com.github.edouardswiac.zerotier.api; 2 | 3 | public final class ZTCRule { 4 | private int ruleNo; 5 | private String nodeId; 6 | private String sourcePort; 7 | private String destPort; 8 | private int vlanId; 9 | private int vlanPcp; 10 | private int etherType; 11 | private String macSource; 12 | private String macDest; 13 | private String ipSource; 14 | private String ipDest; 15 | private int ipTos; 16 | private int ipProtocol; 17 | private int ipSourcePort; 18 | private int ipDestPort; 19 | private String action; 20 | 21 | public int getRuleNo() { 22 | return ruleNo; 23 | } 24 | public String getNodeId() { 25 | return nodeId; 26 | } 27 | public String getSourcePort() { 28 | return sourcePort; 29 | } 30 | public String getDestPort() { 31 | return destPort; 32 | } 33 | public int getVlanId() { 34 | return vlanId; 35 | } 36 | public int getVlanPcp() { 37 | return vlanPcp; 38 | } 39 | public int getEtherType() { 40 | return etherType; 41 | } 42 | public String getMacSource() { 43 | return macSource; 44 | } 45 | public String getMacDest() { 46 | return macDest; 47 | } 48 | public String getIpSource() { 49 | return ipSource; 50 | } 51 | public String getIpDest() { 52 | return ipDest; 53 | } 54 | public int getIpTos() { 55 | return ipTos; 56 | } 57 | public int getIpProtocol() { 58 | return ipProtocol; 59 | } 60 | public int getIpSourcePort() { 61 | return ipSourcePort; 62 | } 63 | public int getIpDestPort() { 64 | return ipDestPort; 65 | } 66 | public String getAction() { 67 | return action; 68 | } 69 | 70 | } 71 | -------------------------------------------------------------------------------- /src/main/java/com/github/edouardswiac/zerotier/api/ZTNetworkConfig.java: -------------------------------------------------------------------------------- 1 | package com.github.edouardswiac.zerotier.api; 2 | 3 | 4 | import com.google.gson.annotations.SerializedName; 5 | 6 | import java.util.Objects; 7 | 8 | public final class ZTNetworkConfig { 9 | private String nwid; 10 | private String name; 11 | private Integer authorizedMemberCount; 12 | @SerializedName("private") 13 | private Boolean isPrivate; 14 | 15 | public ZTNetworkConfig() {} 16 | 17 | public String getNetworkId() { 18 | return nwid; 19 | } 20 | 21 | public String getName() { 22 | return name; 23 | } 24 | 25 | public Integer getAuthorizedMemberCount() { 26 | return authorizedMemberCount; 27 | } 28 | 29 | public Boolean isPrivate() { 30 | return isPrivate; 31 | } 32 | 33 | public void setName(String name) { 34 | this.name = name; 35 | } 36 | 37 | public void setIsPrivate(Boolean isPrivate) { 38 | this.isPrivate = isPrivate; 39 | } 40 | 41 | @Override 42 | public boolean equals(Object o) { 43 | if (this == o) return true; 44 | if (o == null || getClass() != o.getClass()) return false; 45 | ZTNetworkConfig that = (ZTNetworkConfig) o; 46 | return Objects.equals(nwid, that.nwid); 47 | } 48 | 49 | @Override 50 | public int hashCode() { 51 | return Objects.hash(nwid); 52 | } 53 | 54 | @Override 55 | public String toString() { 56 | final StringBuffer sb = new StringBuffer("ZTNetworkConfig{"); 57 | sb.append("nwid='").append(nwid).append('\''); 58 | sb.append(", name='").append(name).append('\''); 59 | sb.append(", authorizedMemberCount=").append(authorizedMemberCount); 60 | sb.append(", isPrivate=").append(isPrivate); 61 | sb.append('}'); 62 | return sb.toString(); 63 | } 64 | } 65 | -------------------------------------------------------------------------------- /src/main/java/com/github/edouardswiac/zerotier/api/ZTNetworkMember.java: -------------------------------------------------------------------------------- 1 | package com.github.edouardswiac.zerotier.api; 2 | 3 | 4 | import java.util.Objects; 5 | 6 | public final class ZTNetworkMember { 7 | private String networkId; 8 | private String state; 9 | private String nodeId; 10 | private ZTNetworkMemberConfig config; 11 | 12 | public ZTNetworkMember() {} 13 | public ZTNetworkMember(String networkId, String address) { 14 | this.networkId = networkId; 15 | this.nodeId = address; 16 | this.config = new ZTNetworkMemberConfig(networkId, address); 17 | } 18 | 19 | public String getNetworkId() { 20 | return networkId; 21 | } 22 | 23 | public String getState() { 24 | return state; 25 | } 26 | 27 | public String getNodeId() { 28 | return nodeId; 29 | } 30 | 31 | public ZTNetworkMemberConfig getConfig() { 32 | return config; 33 | } 34 | 35 | public void setConfig(ZTNetworkMemberConfig config) { 36 | this.config = config; 37 | } 38 | 39 | @Override 40 | public boolean equals(Object o) { 41 | if (this == o) return true; 42 | if (o == null || getClass() != o.getClass()) return false; 43 | ZTNetworkMember that = (ZTNetworkMember) o; 44 | return Objects.equals(networkId, that.networkId); 45 | } 46 | 47 | @Override 48 | public int hashCode() { 49 | return Objects.hash(nodeId); 50 | } 51 | 52 | @Override 53 | public String toString() { 54 | final StringBuffer sb = new StringBuffer("ZTNetworkMember{"); 55 | sb.append("networkId='").append(networkId).append('\''); 56 | sb.append(", state='").append(state).append('\''); 57 | sb.append(", nodeId='").append(nodeId).append('\''); 58 | sb.append(", config=").append(config); 59 | sb.append('}'); 60 | return sb.toString(); 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /src/main/java/com/github/edouardswiac/zerotier/ZTService.java: -------------------------------------------------------------------------------- 1 | package com.github.edouardswiac.zerotier; 2 | 3 | 4 | import com.github.edouardswiac.zerotier.api.ZTNetwork; 5 | import com.github.edouardswiac.zerotier.api.ZTNetworkMember; 6 | import com.github.edouardswiac.zerotier.api.ZTStatus; 7 | 8 | import com.github.edouardswiac.zerotier.api.ZTController; 9 | import com.github.edouardswiac.zerotier.api.ZTCNetwork; 10 | import com.github.edouardswiac.zerotier.api.ZTCMember; 11 | 12 | import java.util.List; 13 | import java.util.Map; 14 | 15 | public interface ZTService { 16 | String API_VERSION = "0.7"; 17 | String ZT_COM_CENTRAL_URL = "https://my.zerotier.com/api/"; 18 | 19 | ZTStatus status(); 20 | 21 | void createNetwork(ZTNetwork network); 22 | List getNetworks(); 23 | ZTNetwork getNetwork(String networkId); 24 | void updateNetwork(ZTNetwork network); 25 | void deleteNetwork(String networkId); 26 | 27 | void createNetworkMember(ZTNetworkMember networkMember); 28 | Map getNetworkMembers(String networkId); 29 | ZTNetworkMember getNetworkMember(String networkId, String address); 30 | void updateNetworkMember(ZTNetworkMember networkMember); 31 | void deleteNetworkMember(String networkId, String address); 32 | 33 | List getNets(); 34 | ZTNetwork joinNet(String nwid); 35 | 36 | ZTController controller(); 37 | List getCNetworks(); 38 | ZTCNetwork getCNetwork(String networkId); 39 | ZTCNetwork updateCNetwork(ZTCNetwork network); 40 | void deleteCNetwork(String networkId); 41 | 42 | Map getCMembers(String networkId); 43 | ZTCMember getCMember(String networkId, String memberId); 44 | ZTCMember updateCMember(ZTCMember member); 45 | void deleteCMember(ZTCMember member); 46 | void deleteCMember(String networkId, String memberId); 47 | } 48 | -------------------------------------------------------------------------------- /src/main/java/com/github/edouardswiac/zerotier/api/ZTStatus.java: -------------------------------------------------------------------------------- 1 | package com.github.edouardswiac.zerotier.api; 2 | 3 | 4 | public final class ZTStatus { 5 | private String address; 6 | private String publicIdentity; 7 | private long worldId; 8 | private long worldTimestamp; 9 | private Boolean online; 10 | private Boolean tcpFallbackActive; 11 | private int versionMajor; 12 | private int versionMinor; 13 | private int versionRev; 14 | private String version; 15 | private long clock; 16 | private Object cluster; 17 | 18 | public ZTStatus() { 19 | } 20 | 21 | public String getAddress() { 22 | return address; 23 | } 24 | 25 | public String getPublicIdentity() { 26 | return publicIdentity; 27 | } 28 | 29 | public long getWorldId() { 30 | return worldId; 31 | } 32 | 33 | public long getWorldTimestamp() { 34 | return worldTimestamp; 35 | } 36 | 37 | public Boolean getOnline() { 38 | return online; 39 | } 40 | 41 | public Boolean getTcpFallbackActive() { 42 | return tcpFallbackActive; 43 | } 44 | 45 | public int getVersionMajor() { 46 | return versionMajor; 47 | } 48 | 49 | public int getVersionMinor() { 50 | return versionMinor; 51 | } 52 | 53 | public int getVersionRev() { 54 | return versionRev; 55 | } 56 | 57 | public long getClock() { 58 | return clock; 59 | } 60 | 61 | public Object getCluster() { 62 | return cluster; 63 | } 64 | 65 | public boolean isOnline() { 66 | return online; 67 | } 68 | 69 | public String getVersion() { 70 | return version; 71 | } 72 | 73 | @Override 74 | public String toString() { 75 | final StringBuffer sb = new StringBuffer("ZTStatus{"); 76 | sb.append("online=").append(online); 77 | sb.append(", version='").append(version).append('\''); 78 | sb.append('}'); 79 | return sb.toString(); 80 | } 81 | } 82 | -------------------------------------------------------------------------------- /src/main/java/com/github/edouardswiac/zerotier/api/ZTNetworkMemberConfig.java: -------------------------------------------------------------------------------- 1 | package com.github.edouardswiac.zerotier.api; 2 | 3 | 4 | import java.util.Objects; 5 | 6 | public final class ZTNetworkMemberConfig { 7 | private String nwid; 8 | private String address; 9 | private Boolean authorized; 10 | private Boolean activeBridge; 11 | private String identity; 12 | 13 | public ZTNetworkMemberConfig() {} 14 | public ZTNetworkMemberConfig(String networkId, String address) { 15 | this.nwid = networkId; 16 | this.address = address; 17 | } 18 | 19 | public String getNetworkId() { 20 | return nwid; 21 | } 22 | 23 | public String getAddress() { 24 | return address; 25 | } 26 | 27 | public Boolean isAuthorized() { 28 | return authorized; 29 | } 30 | 31 | public void setAuthorized(Boolean authorized) { 32 | this.authorized = authorized; 33 | } 34 | 35 | public Boolean getActiveBridge() { 36 | return activeBridge; 37 | } 38 | 39 | public void setActiveBridge(Boolean activeBridge) { 40 | this.activeBridge = activeBridge; 41 | } 42 | 43 | public String getIdentity() { 44 | return identity; 45 | } 46 | 47 | @Override 48 | public boolean equals(Object o) { 49 | if (this == o) return true; 50 | if (o == null || getClass() != o.getClass()) return false; 51 | ZTNetworkMemberConfig that = (ZTNetworkMemberConfig) o; 52 | return Objects.equals(address, that.address); 53 | } 54 | 55 | @Override 56 | public int hashCode() { 57 | return Objects.hash(address); 58 | } 59 | 60 | @Override 61 | public String toString() { 62 | final StringBuffer sb = new StringBuffer("ZTNetworkMemberConfig{"); 63 | sb.append("nwid='").append(nwid).append('\''); 64 | sb.append(", address='").append(address).append('\''); 65 | sb.append(", authorized=").append(authorized); 66 | sb.append(", activeBridge=").append(activeBridge); 67 | sb.append('}'); 68 | return sb.toString(); 69 | } 70 | } 71 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # zerotier-api-java [![Build Status](https://travis-ci.org/edouardswiac/zerotier-api-java.svg?branch=master)](https://travis-ci.org/edouardswiac/zerotier-api-java) 2 | A Java library that helps you manage ZeroTier networks (https://www.zerotier.com/). The library requires an API Access Token and lets you query the status of ZeroTier and create/update/delete networks and members. 3 | 4 | 5 | ## Requirements 6 | - Java 7+ 7 | - A ZeroTier API access token (get it from https://my.zerotier.com/ > Account) 8 | 9 | 10 | ## Installation 11 | The library is published to maven central. If you use Maven, you can add a depency on it in your pom.xml: 12 | ```xml 13 | 14 | com.github.edouardswiac 15 | zerotier-api-java 16 | 0.6.2 17 | 18 | ``` 19 | The library uses [OkHttp](http://square.github.io/okhttp/) for HTTP'ing and [Gson](https://github.com/google/gson) for JSON'ing. 20 | 21 | 22 | ## Features 23 | The [`ZTService`](src/main/java/com/github/edouardswiac/zerotier/ZTService.java) interface describes the service and its available methods. The provided implementation, [`ZTServiceImpl`](src/main/java/com/github/edouardswiac/zerotier/ZTServiceImpl.java), makes HTTP requests to ZeroTier's Central REST API. 24 | 25 | A quick list of what you can achieve with zerotier-api-java: 26 | - ***status*** query the status of ZeroTier, see if it's online and the API version (used in the regression test) 27 | - ***network*** create a network, update a network, delete a network 28 | - ***member*** create a member, update a member, delete a member 29 | 30 | Note that all the corresponding fields are not implemented. If you need more fields and want to contribute to the project, please submit a pull request with your changes along some integration testing. 31 | 32 | ## Examples 33 | ```java 34 | ZTService ztService = new ZTServiceImpl("ZT_AUTH_TOKEN"); 35 | 36 | // create a network 37 | s.createNetwork(new ZTNetwork("my cool network")); 38 | 39 | // create a member in networkId 40 | ZTNetworkMember ztNetworkMember = new ZTNetworkMember(networkId, newMemberAddress); 41 | s.createNetworkMember(ztNetworkMember); 42 | 43 | // update a member 44 | ztNetworkMember.getConfig().setAuthorized(true); 45 | s.updateNetworkMember(ztNetworkMember); 46 | ``` 47 | 48 | ## Testing 49 | An integration test suite, [`ZTServiceTest`](src/test/java/com/github/edouardswiac/zerotier/ZTServiceTest.java), is available and run by TravisCI to make sure there are no regressions. You need to set the `ZT_AUTH_TOKEN` system property ex: `ZT_AUTH_TOKEN=...token... mvn verify` to run the integration test suite. 50 | -------------------------------------------------------------------------------- /src/main/java/com/github/edouardswiac/zerotier/api/ZTNetwork.java: -------------------------------------------------------------------------------- 1 | package com.github.edouardswiac.zerotier.api; 2 | 3 | import java.util.List; 4 | import java.util.Objects; 5 | 6 | public final class ZTNetwork { 7 | private String nwid; 8 | private String mac; 9 | private String name; 10 | private String status; 11 | private String type; 12 | private int mtu; 13 | private boolean dhcp; 14 | private boolean bridge; 15 | private boolean broadcastEnabled; 16 | private int portError; 17 | private int netconfRevision; 18 | private List multicastSubscriptions; 19 | private List assignedAddresses; 20 | private String portDeviceName; 21 | 22 | private ZTNetworkConfig config; 23 | 24 | public ZTNetwork() { 25 | } 26 | 27 | public ZTNetwork(String newNetworkName) { 28 | this.config = new ZTNetworkConfig(); 29 | this.config.setName(name); 30 | } 31 | 32 | public String getNwid() { 33 | return nwid; 34 | } 35 | 36 | public String getMac() { 37 | return mac; 38 | } 39 | 40 | public String getName() { 41 | return name; 42 | } 43 | 44 | public int getMtu() { 45 | return mtu; 46 | } 47 | 48 | public boolean isDhcp() { 49 | return dhcp; 50 | } 51 | 52 | public boolean isBridge() { 53 | return bridge; 54 | } 55 | 56 | public boolean isBroadcastEnabled() { 57 | return broadcastEnabled; 58 | } 59 | 60 | public int getNetconfRevision() { 61 | return netconfRevision; 62 | } 63 | 64 | public List getMulticastSubscriptions() { 65 | return multicastSubscriptions; 66 | } 67 | 68 | public List getAssignedAddresses() { 69 | return assignedAddresses; 70 | } 71 | 72 | public String getStatus() { 73 | return status; 74 | } 75 | 76 | public String getType() { 77 | return type; 78 | } 79 | 80 | public int getPortError() { 81 | return portError; 82 | } 83 | 84 | public String getPortDeviceName() { 85 | return portDeviceName; 86 | } 87 | 88 | public ZTNetworkConfig getConfig() { 89 | return config; 90 | } 91 | 92 | @Override 93 | public boolean equals(Object o) { 94 | if (this == o) 95 | return true; 96 | if (o == null || getClass() != o.getClass()) 97 | return false; 98 | ZTNetwork ztNet = (ZTNetwork) o; 99 | return Objects.equals(nwid, ztNet.nwid); 100 | } 101 | 102 | @Override 103 | public int hashCode() { 104 | return Objects.hash(nwid); 105 | } 106 | 107 | @Override 108 | public String toString() { 109 | final StringBuffer sb = new StringBuffer("ZTNetwork{"); 110 | sb.append("nwid='").append(nwid).append('\''); 111 | sb.append(", name=").append(name); 112 | sb.append('}'); 113 | return sb.toString(); 114 | } 115 | } 116 | -------------------------------------------------------------------------------- /src/main/java/com/github/edouardswiac/zerotier/api/ZTCMember.java: -------------------------------------------------------------------------------- 1 | package com.github.edouardswiac.zerotier.api; 2 | 3 | import java.util.ArrayList; 4 | import java.util.List; 5 | 6 | public class ZTCMember implements Cloneable { 7 | private String nwid; 8 | private long clock; 9 | private String address; 10 | private boolean authorized; 11 | private boolean activeBridge; 12 | private String identity; 13 | private List ipAssignments; 14 | private int memberRevision; 15 | 16 | public boolean isAuthorized() { 17 | return authorized; 18 | } 19 | 20 | public void setAuthorized(boolean authorized) { 21 | this.authorized = authorized; 22 | } 23 | 24 | public boolean isActiveBridge() { 25 | return activeBridge; 26 | } 27 | 28 | public void setActiveBridge(boolean activaBridge) { 29 | this.activeBridge = activaBridge; 30 | } 31 | 32 | public List getIpAssignments() { 33 | return ipAssignments; 34 | } 35 | 36 | public void setIpAssignments(List ipAssignments) { 37 | this.ipAssignments = ipAssignments; 38 | } 39 | 40 | public String getNwid() { 41 | return nwid; 42 | } 43 | 44 | public long getClock() { 45 | return clock; 46 | } 47 | 48 | public String getAddress() { 49 | return address; 50 | } 51 | 52 | public String getIdentity() { 53 | return identity; 54 | } 55 | 56 | public int getMemberRevision() { 57 | return memberRevision; 58 | } 59 | 60 | @Override 61 | public String toString() { 62 | final StringBuffer sb = new StringBuffer("ZTCMember{"); 63 | sb.append("nwid=").append(nwid); 64 | sb.append(", address=='").append(address).append('\''); 65 | sb.append(", identity='").append(identity).append('\''); 66 | sb.append(", revision='").append(memberRevision).append('\''); 67 | if (ipAssignments != null) { 68 | sb.append(", assignments=["); 69 | boolean first = true; 70 | for (String s : ipAssignments) { 71 | if (!first) 72 | sb.append(", "); 73 | else 74 | first = false; 75 | sb.append('\'').append(s).append('\''); 76 | } 77 | sb.append(memberRevision).append(']'); 78 | } 79 | sb.append('}'); 80 | return sb.toString(); 81 | } 82 | 83 | @Override 84 | public ZTCMember clone() { 85 | ZTCMember m; 86 | try { 87 | m = (ZTCMember) super.clone(); 88 | m.ipAssignments = new ArrayList(ipAssignments); // may be changed, deep clone! 89 | return m; 90 | } catch (CloneNotSupportedException e) { 91 | System.err.println(e.getMessage());; 92 | } 93 | return null; 94 | } 95 | 96 | @Override 97 | public boolean equals(Object o) { 98 | if (!(o instanceof ZTCMember)) 99 | return false; 100 | ZTCMember m = (ZTCMember) o; 101 | if ((nwid != null && !nwid.equals(m.nwid)) || !(nwid == null && m.nwid == null)) 102 | return false; 103 | if ((address != null && !address.equals(m.address)) || !(address == null && m.address == null)) 104 | return false; 105 | if (authorized != m.authorized) 106 | return false; 107 | if (activeBridge != m.activeBridge) 108 | return false; 109 | if ((identity != null && !identity.equals(m.identity)) || !(identity == null && m.identity == null)) 110 | return false; 111 | if (memberRevision != m.memberRevision) 112 | return false; 113 | if (ipAssignments.size() != m.ipAssignments.size()) 114 | return false; 115 | for (int i=0; i membersWithRevisions = s.getNetworkMembers(networkId); 61 | assertThat(membersWithRevisions).isEmpty(); 62 | 63 | // create member 64 | ZTNetworkMember ztNetworkMember = new ZTNetworkMember(networkId, newMemberAddress); 65 | s.createNetworkMember(ztNetworkMember); 66 | 67 | // make sure it's there 68 | ztNetworkMember = s.getNetworkMember(networkId, newMemberAddress); 69 | assertThat(ztNetworkMember).isNotNull().withFailMessage("new member was not created"); 70 | assertThat(ztNetworkMember.getNetworkId()).isEqualTo(networkId); 71 | assertThat(ztNetworkMember.getNodeId()).isEqualTo(newMemberAddress); 72 | 73 | // update member 74 | boolean oldIsAuth = ztNetworkMember.getConfig().isAuthorized(); 75 | boolean newIsAuth = !oldIsAuth; 76 | 77 | System.out.println("authorizing new member"); 78 | ztNetworkMember.getConfig().setAuthorized(newIsAuth); 79 | s.updateNetworkMember(ztNetworkMember); 80 | 81 | ztNetworkMember = s.getNetworkMember(networkId, newMemberAddress); 82 | assertThat(ztNetworkMember.getConfig().isAuthorized()).isEqualTo(newIsAuth).withFailMessage("new member not updated"); 83 | 84 | ztNetworkMember = s.getNetworkMember(networkId, newMemberAddress); 85 | ztNetworkMember.getConfig().setAuthorized(oldIsAuth); 86 | s.updateNetworkMember(ztNetworkMember); 87 | 88 | ztNetworkMember = s.getNetworkMember(networkId, newMemberAddress); 89 | assertThat(ztNetworkMember.getConfig().isAuthorized()).isEqualTo(oldIsAuth).withFailMessage("new member not updated");; 90 | 91 | // update network testing this by toggling the name 92 | ZTNetwork ztNetwork = s.getNetwork(networkId); 93 | String oldName = ztNetwork.getConfig().getName(); 94 | String testName = oldName+" updated"; 95 | 96 | System.out.println("setting up new name"); 97 | ztNetwork.getConfig().setName(testName); 98 | System.out.println(ztNetwork); 99 | s.updateNetwork(ztNetwork); 100 | 101 | System.out.println("checking that new name has been applied"); 102 | ztNetwork = s.getNetwork(networkId); 103 | System.out.println(ztNetwork); 104 | assertThat(ztNetwork.getConfig().getName()).isEqualTo(testName).withFailMessage("network not upated"); 105 | 106 | System.out.println("reverting to old name"); 107 | ztNetwork.getConfig().setName(oldName); 108 | s.updateNetwork(ztNetwork); 109 | 110 | System.out.println("checking that old name has been restored"); 111 | ztNetwork = s.getNetwork(networkId); 112 | System.out.println(ztNetwork); 113 | assertThat(ztNetwork.getConfig().getName()).isEqualTo(oldName).withFailMessage("network not upated"); 114 | 115 | // delete member 116 | s.deleteNetworkMember(networkId, newMemberAddress); 117 | 118 | // delete network 119 | s.deleteNetwork(network.getNwid()); 120 | } 121 | 122 | } 123 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | 5 | com.github.edouardswiac 6 | zerotier-api-java 7 | 0.6.3-SNAPSHOT 8 | 9 | 10 | 11 | UTF-8 12 | UTF-8 13 | 1.7.12 14 | 15 | 16 | ZeroTier API Java 17 | https://github.com/edouardswiac/zerotier-api-java 18 | A Java library that helps manage ZeroTier networks. 19 | 20 | 21 | 22 | GPLv3 23 | http://www.gnu.org/licenses/gpl-3.0.en.html 24 | repo 25 | 26 | 27 | 28 | 29 | 30 | Edouard Swiac 31 | edouard.swiac@gmail.com 32 | America/Los_Angeles 33 | 34 | author 35 | 36 | 37 | 38 | 39 | 40 | scm:git:git://github.com/edouardswiac/zerotier-api-java.git 41 | scm:git:git@github.com:edouardswiac/zerotier-api-java.git 42 | https://github.com/edouardswiac/zerotier-api-java 43 | HEAD 44 | 45 | 46 | 47 | 48 | ossrh 49 | https://oss.sonatype.org/content/repositories/snapshots 50 | 51 | 52 | ossrh 53 | https://oss.sonatype.org/service/local/staging/deploy/maven2/ 54 | 55 | 56 | 57 | 58 | 59 | com.squareup.okhttp 60 | okhttp 61 | 2.5.0 62 | 63 | 64 | com.google.code.gson 65 | gson 66 | 2.8.9 67 | 68 | 69 | org.slf4j 70 | slf4j-api 71 | ${slf4j.version} 72 | 73 | 74 | javax.validation 75 | validation-api 76 | 1.1.0.Final 77 | 78 | 79 | 80 | 81 | 82 | junit 83 | junit 84 | 4.13.1 85 | test 86 | 87 | 88 | org.assertj 89 | assertj-core 90 | 2.2.0 91 | test 92 | 93 | 94 | org.mockito 95 | mockito-all 96 | 2.0.2-beta 97 | test 98 | 99 | 100 | org.slf4j 101 | slf4j-simple 102 | ${slf4j.version} 103 | test 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | org.jacoco 113 | jacoco-maven-plugin 114 | 0.7.5.201505241946 115 | 116 | 117 | 118 | prepare-agent 119 | 120 | 121 | 122 | report 123 | prepare-package 124 | 125 | report 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | org.apache.maven.plugins 134 | maven-compiler-plugin 135 | 3.1 136 | 137 | 1.7 138 | 1.7 139 | UTF-8 140 | 141 | -Xlint:all 142 | -Werror 143 | 144 | true 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | release 154 | 155 | 156 | 157 | 158 | 159 | 160 | org.apache.maven.plugins 161 | maven-source-plugin 162 | 2.2.1 163 | 164 | 165 | attach-sources 166 | 167 | jar-no-fork 168 | 169 | 170 | 171 | 172 | 173 | org.apache.maven.plugins 174 | maven-javadoc-plugin 175 | 2.9.1 176 | 177 | 178 | attach-javadocs 179 | 180 | jar 181 | 182 | 183 | 184 | 185 | 186 | org.apache.maven.plugins 187 | maven-gpg-plugin 188 | 1.5 189 | 190 | 191 | sign-artifacts 192 | verify 193 | 194 | sign 195 | 196 | 197 | 198 | 199 | 200 | org.sonatype.plugins 201 | nexus-staging-maven-plugin 202 | 1.6.3 203 | true 204 | 205 | ossrh 206 | https://oss.sonatype.org/ 207 | true 208 | 209 | 210 | 211 | org.apache.maven.plugins 212 | maven-release-plugin 213 | 2.5.3 214 | 215 | @${project.version} 216 | 217 | 218 | 219 | 220 | 221 | 222 | -------------------------------------------------------------------------------- /src/main/java/com/github/edouardswiac/zerotier/api/ZTCNetwork.java: -------------------------------------------------------------------------------- 1 | package com.github.edouardswiac.zerotier.api; 2 | 3 | import java.util.ArrayList; 4 | import java.util.List; 5 | import java.util.regex.Matcher; 6 | import java.util.regex.Pattern; 7 | 8 | import com.google.gson.annotations.SerializedName; 9 | 10 | public final class ZTCNetwork implements Cloneable { 11 | private String nwid; 12 | protected String name; 13 | @SerializedName("private") protected boolean privat; 14 | protected boolean enableBroadcast; 15 | protected boolean allowPassiveBridging; 16 | protected String v4AssignMode; 17 | protected String v6AssignMode; 18 | protected int multicastLimit; 19 | private long creationTime; 20 | private int revision; 21 | private int memberRevisionCounter; 22 | private long clock; 23 | private int authorizedMemberCount; 24 | protected List relays; 25 | protected List ipLocalRoutes; 26 | protected List ipAssignmentPools; 27 | protected List rules; 28 | 29 | private String controllerInstanceId; 30 | private List gateways; 31 | 32 | public String getNwid() { 33 | return nwid; 34 | } 35 | 36 | public String getControllerInstanceId() { 37 | return controllerInstanceId; 38 | } 39 | 40 | public long getClock() { 41 | return clock; 42 | } 43 | 44 | public String getName() { 45 | return name; 46 | } 47 | 48 | public void setName(String name) { 49 | this.name = name; 50 | } 51 | 52 | public boolean isPrivate() { 53 | return privat; 54 | } 55 | 56 | public void setPrivate(boolean privat) { 57 | this.privat = privat; 58 | } 59 | 60 | public boolean isEnableBroadcast() { 61 | return enableBroadcast; 62 | } 63 | 64 | public void setEnableBroadcast(boolean enableBroadcast) { 65 | this.enableBroadcast = enableBroadcast; 66 | } 67 | 68 | public boolean isAllowPassiveBridging() { 69 | return allowPassiveBridging; 70 | } 71 | 72 | public void setAllowPassiveBridging(boolean allowPassiveBridging) { 73 | this.allowPassiveBridging = allowPassiveBridging; 74 | } 75 | 76 | public String getV4AssignMode() { 77 | return v4AssignMode; 78 | } 79 | 80 | public void setV4AssignMode(String v4AssignMode) { 81 | this.v4AssignMode = v4AssignMode; 82 | } 83 | 84 | public String getV6AssignMode() { 85 | return v6AssignMode; 86 | } 87 | 88 | public void setV6AssignMode(String v6AssignMode) { 89 | this.v6AssignMode = v6AssignMode; 90 | } 91 | 92 | public int getMulticastLimit() { 93 | return multicastLimit; 94 | } 95 | 96 | public void setMulticastLimit(int multicastLimit) { 97 | this.multicastLimit = multicastLimit; 98 | } 99 | 100 | public long getCreationTime() { 101 | return creationTime; 102 | } 103 | 104 | public int getRevision() { 105 | return revision; 106 | } 107 | 108 | public int getMemberRevisionCounter() { 109 | return memberRevisionCounter; 110 | } 111 | 112 | public int getAuthorizedMemberCount() { 113 | return authorizedMemberCount; 114 | } 115 | 116 | public List getRelays() { 117 | return relays; 118 | } 119 | 120 | public void setRelays(List relays) { 121 | this.relays = relays; 122 | } 123 | 124 | public List getGateways() { 125 | return gateways; 126 | } 127 | 128 | public List getIpLocalRoutes() { 129 | return ipLocalRoutes; 130 | } 131 | 132 | public void setIpLocalRoutes(List ipLocalRoutes) { 133 | this.ipLocalRoutes = ipLocalRoutes; 134 | } 135 | 136 | public List getIpAssignmentPools() { 137 | return ipAssignmentPools; 138 | } 139 | 140 | public void setIpAssignmentPools(List ipAssignmentPools) { 141 | this.ipAssignmentPools = ipAssignmentPools; 142 | } 143 | 144 | public List getRules() { 145 | return rules; 146 | } 147 | 148 | public void setRules(List rules) { 149 | this.rules = rules; 150 | } 151 | 152 | @Override 153 | public int hashCode() { 154 | final int prime = 31; 155 | int result = 1; 156 | result = prime * result + (allowPassiveBridging ? 1231 : 1237); 157 | result = prime * result + authorizedMemberCount; 158 | result = prime * result + ((controllerInstanceId == null) ? 0 : controllerInstanceId.hashCode()); 159 | result = prime * result + (enableBroadcast ? 1231 : 1237); 160 | result = prime * result + ((gateways == null) ? 0 : gateways.hashCode()); 161 | result = prime * result + ((ipAssignmentPools == null) ? 0 : ipAssignmentPools.hashCode()); 162 | result = prime * result + ((ipLocalRoutes == null) ? 0 : ipLocalRoutes.hashCode()); 163 | result = prime * result + multicastLimit; 164 | result = prime * result + ((name == null) ? 0 : name.hashCode()); 165 | result = prime * result + ((nwid == null) ? 0 : nwid.hashCode()); 166 | result = prime * result + (privat ? 1231 : 1237); 167 | result = prime * result + ((v4AssignMode == null) ? 0 : v4AssignMode.hashCode()); 168 | result = prime * result + ((v6AssignMode == null) ? 0 : v6AssignMode.hashCode()); 169 | return result; 170 | } 171 | 172 | @Override 173 | public boolean equals(Object obj) { 174 | if (this == obj) 175 | return true; 176 | if (obj == null) 177 | return false; 178 | if (getClass() != obj.getClass()) 179 | return false; 180 | ZTCNetwork other = (ZTCNetwork) obj; 181 | if (allowPassiveBridging != other.allowPassiveBridging) 182 | return false; 183 | if (authorizedMemberCount != other.authorizedMemberCount) 184 | return false; 185 | if (controllerInstanceId == null) { 186 | if (other.controllerInstanceId != null) 187 | return false; 188 | } else if (!controllerInstanceId.equals(other.controllerInstanceId)) 189 | return false; 190 | if (enableBroadcast != other.enableBroadcast) 191 | return false; 192 | if (gateways == null) { 193 | if (other.gateways != null) 194 | return false; 195 | } else if (!gateways.equals(other.gateways)) 196 | return false; 197 | if (ipAssignmentPools == null) { 198 | if (other.ipAssignmentPools != null) 199 | return false; 200 | } else if (!ipAssignmentPools.equals(other.ipAssignmentPools)) 201 | return false; 202 | if (ipLocalRoutes == null) { 203 | if (other.ipLocalRoutes != null) 204 | return false; 205 | } else if (!ipLocalRoutes.equals(other.ipLocalRoutes)) 206 | return false; 207 | if (multicastLimit != other.multicastLimit) 208 | return false; 209 | if (name == null) { 210 | if (other.name != null) 211 | return false; 212 | } else if (!name.equals(other.name)) 213 | return false; 214 | if (nwid == null) { 215 | if (other.nwid != null) 216 | return false; 217 | } else if (!nwid.equals(other.nwid)) 218 | return false; 219 | if (privat != other.privat) 220 | return false; 221 | if (v4AssignMode == null) { 222 | if (other.v4AssignMode != null) 223 | return false; 224 | } else if (!v4AssignMode.equals(other.v4AssignMode)) 225 | return false; 226 | if (v6AssignMode == null) { 227 | if (other.v6AssignMode != null) 228 | return false; 229 | } else if (!v6AssignMode.equals(other.v6AssignMode)) 230 | return false; 231 | return true; 232 | } 233 | 234 | @Override 235 | public ZTCNetwork clone() { 236 | try { 237 | ZTCNetwork n = (ZTCNetwork) super.clone(); 238 | n.relays = new ArrayList<>(relays); 239 | n.ipLocalRoutes = new ArrayList<>(ipLocalRoutes); 240 | n.ipAssignmentPools = new ArrayList<>(ipAssignmentPools); 241 | n.rules = new ArrayList<>(rules); 242 | n.gateways = new ArrayList<>(gateways); 243 | return n; 244 | } catch (CloneNotSupportedException e) { 245 | System.err.println("Unable to clone ZTCNetwork: '"+e.getMessage()+"'"); 246 | } 247 | return null; 248 | } 249 | // this is needed to request a new network creation 250 | public void initNetworkId(String nwid) { 251 | Pattern p = Pattern.compile("(\\p{XDigit}{10})(______|\\p{XDigit}{6})"); 252 | Matcher m = p.matcher(nwid); 253 | if (!m.matches()) 254 | throw new IllegalArgumentException("Network id must be a 16 digit hexadecimal number"); 255 | if (!m.group(1).equals(controllerInstanceId)) 256 | throw new IllegalArgumentException("Network id must match Controller Id"); 257 | this.nwid = nwid; 258 | } 259 | 260 | } 261 | -------------------------------------------------------------------------------- /src/main/java/com/github/edouardswiac/zerotier/ZTServiceImpl.java: -------------------------------------------------------------------------------- 1 | package com.github.edouardswiac.zerotier; 2 | 3 | 4 | import com.github.edouardswiac.zerotier.api.ZTCMember; 5 | import com.github.edouardswiac.zerotier.api.ZTCNetwork; 6 | import com.github.edouardswiac.zerotier.api.ZTController; 7 | import com.github.edouardswiac.zerotier.api.ZTNetwork; 8 | import com.github.edouardswiac.zerotier.api.ZTNetworkMember; 9 | import com.github.edouardswiac.zerotier.api.ZTStatus; 10 | import com.github.edouardswiac.zerotier.exceptions.ZTClientException; 11 | import com.github.edouardswiac.zerotier.exceptions.ZTServiceException; 12 | import com.github.edouardswiac.zerotier.interceptors.AuthenticationInterceptor; 13 | import com.github.edouardswiac.zerotier.interceptors.LoggingInterceptor; 14 | import com.github.edouardswiac.zerotier.interceptors.UserAgentInterceptor; 15 | import com.google.gson.Gson; 16 | import com.google.gson.reflect.TypeToken; 17 | import com.squareup.okhttp.*; 18 | import org.slf4j.Logger; 19 | import org.slf4j.LoggerFactory; 20 | 21 | import javax.validation.constraints.NotNull; 22 | import java.io.IOException; 23 | import java.lang.reflect.Type; 24 | import java.util.*; 25 | 26 | 27 | public final class ZTServiceImpl implements ZTService { 28 | private final OkHttpClient client; 29 | private final Gson gson; 30 | private final HttpUrl baseApiUrl; 31 | 32 | private final static Logger LOG = LoggerFactory.getLogger("HTTP Client"); 33 | private final static String USER_AGENT = String.format("ZeroTier API Java Client v%s ", API_VERSION); 34 | private final static MediaType MEDIA_TYPE_JSON = MediaType.parse("application/json; charset=utf-8"); 35 | 36 | public ZTServiceImpl(String apiAccessToken) { 37 | this(ZT_COM_CENTRAL_URL, apiAccessToken); 38 | } 39 | 40 | public ZTServiceImpl(String ztCentralUrl, String apiAccessToken) { 41 | this.gson = new Gson(); 42 | 43 | this.client = new OkHttpClient(); 44 | // user agent 45 | client.interceptors().add(new UserAgentInterceptor(USER_AGENT)); 46 | // auth 47 | client.interceptors().add(new AuthenticationInterceptor(apiAccessToken)); 48 | // logging 49 | client.interceptors().add(new LoggingInterceptor(LOG)); 50 | 51 | this.baseApiUrl = HttpUrl.parse(ztCentralUrl); 52 | } 53 | 54 | @Override 55 | public void createNetwork(ZTNetwork network) { 56 | final HttpUrl targetUrl = baseApiUrl.newBuilder() 57 | .addPathSegment("network") 58 | .build(); 59 | 60 | final Request request = new Request.Builder() 61 | .url(targetUrl) 62 | .post(RequestBody.create(MEDIA_TYPE_JSON, gson.toJson(network))) 63 | .build(); 64 | execute(request); 65 | } 66 | 67 | @Override 68 | public List getNetworks() { 69 | final HttpUrl targetUrl = baseApiUrl.newBuilder().addPathSegment("network").build(); 70 | final Request request = new Request.Builder().url(targetUrl).build(); 71 | return Arrays.asList(get(request, ZTNetwork[].class)); 72 | } 73 | 74 | @Override 75 | public ZTNetwork getNetwork(@NotNull String networkId) { 76 | final HttpUrl targetUrl = baseApiUrl.newBuilder() 77 | .addPathSegment("network") 78 | .addPathSegment(networkId) 79 | .build(); 80 | final Request request = new Request.Builder().url(targetUrl).build(); 81 | return get(request, ZTNetwork.class); 82 | } 83 | 84 | @Override 85 | public void updateNetwork(@NotNull ZTNetwork network) { 86 | if (network.getNwid() == null) 87 | throw new IllegalArgumentException("network ID must not be null"); 88 | 89 | final HttpUrl targetUrl = baseApiUrl.newBuilder() 90 | .addPathSegment("network") 91 | .addPathSegment(network.getNwid()) 92 | .build(); 93 | 94 | final Request request = new Request.Builder() 95 | .url(targetUrl) 96 | .post(RequestBody.create(MEDIA_TYPE_JSON, gson.toJson(network))) 97 | .build(); 98 | execute(request); 99 | } 100 | 101 | @Override 102 | public void deleteNetwork(@NotNull String networkId) { 103 | final HttpUrl targetUrl = baseApiUrl.newBuilder() 104 | .addPathSegment("network") 105 | .addPathSegment(networkId) 106 | .build(); 107 | 108 | final Request request = new Request.Builder() 109 | .url(targetUrl) 110 | .delete() 111 | .build(); 112 | try { 113 | execute(request); 114 | } catch (ZTServiceException ex) { 115 | // catch the 500 that's returned when deleting :/ 116 | if (!ex.getCause().getLocalizedMessage().contains("code=500")) { 117 | throw ex; 118 | } 119 | } 120 | } 121 | 122 | @Override 123 | public Map getNetworkMembers(@NotNull String networkId) { 124 | final HttpUrl targetUrl = baseApiUrl.newBuilder() 125 | .addPathSegment("network") 126 | .addPathSegment(networkId) 127 | .addPathSegment("member") 128 | .build(); 129 | final Type entityType = new TypeToken>(){}.getType(); 130 | final Request request = new Request.Builder().url(targetUrl).build(); 131 | final Map membersWithVersion = get(request, entityType); 132 | return Collections.unmodifiableMap(membersWithVersion); 133 | } 134 | 135 | @Override 136 | public void createNetworkMember(@NotNull ZTNetworkMember networkMember) { 137 | // zt api treats it the same 138 | updateNetworkMember(networkMember); 139 | } 140 | 141 | @Override 142 | public ZTNetworkMember getNetworkMember(@NotNull String networkId, @NotNull String address) { 143 | final HttpUrl targetUrl = baseApiUrl.newBuilder() 144 | .addPathSegment("network") 145 | .addPathSegment(networkId) 146 | .addPathSegment("member") 147 | .addPathSegment(address) 148 | .build(); 149 | final Request request = new Request.Builder().url(targetUrl).build(); 150 | return get(request, ZTNetworkMember.class); 151 | } 152 | 153 | @Override 154 | public void updateNetworkMember(@NotNull ZTNetworkMember networkMember) { 155 | if (networkMember.getNetworkId() == null) 156 | throw new IllegalArgumentException("network ID must not be null"); 157 | if (networkMember.getNodeId() == null) 158 | throw new IllegalArgumentException("node ID must not be null"); 159 | 160 | final HttpUrl targetUrl = baseApiUrl.newBuilder() 161 | .addPathSegment("network") 162 | .addPathSegment(networkMember.getNetworkId()) 163 | .addPathSegment("member") 164 | .addPathSegment(networkMember.getNodeId()) 165 | .build(); 166 | 167 | final Request request = new Request.Builder() 168 | .url(targetUrl) 169 | .post(RequestBody.create(MEDIA_TYPE_JSON, gson.toJson(networkMember))) 170 | .build(); 171 | execute(request); 172 | } 173 | 174 | @Override 175 | public void deleteNetworkMember(@NotNull String networkId, String address) { 176 | final HttpUrl targetUrl = baseApiUrl.newBuilder() 177 | .addPathSegment("network") 178 | .addPathSegment(networkId) 179 | .addPathSegment("member") 180 | .addPathSegment(address) 181 | .build(); 182 | 183 | final Request request = new Request.Builder() 184 | .url(targetUrl) 185 | .delete() 186 | .build(); 187 | execute(request); 188 | } 189 | 190 | //======================================= 191 | 192 | @Override 193 | public ZTStatus status() { 194 | final HttpUrl targetUrl = baseApiUrl.newBuilder().addPathSegment("status").build(); 195 | final Request request = new Request.Builder().url(targetUrl).build(); 196 | return get(request, ZTStatus.class); 197 | } 198 | 199 | @Override 200 | public List getNets() { 201 | final HttpUrl targetUrl = baseApiUrl.newBuilder().addPathSegment("network").build(); 202 | final Request request = new Request.Builder().url(targetUrl).build(); 203 | return Arrays.asList(get(request, ZTNetwork[].class)); 204 | } 205 | 206 | @Override 207 | public ZTNetwork joinNet(String nwid) { 208 | final HttpUrl targetUrl = baseApiUrl.newBuilder() 209 | .addPathSegment("network") 210 | .addPathSegment(nwid) 211 | .build(); 212 | final Request request = new Request.Builder() 213 | .url(targetUrl) 214 | .post(RequestBody.create(MEDIA_TYPE_JSON, "{}")) 215 | .build(); 216 | return get(request, ZTNetwork.class); 217 | } 218 | 219 | @Override 220 | public ZTController controller() { 221 | final HttpUrl targetUrl = baseApiUrl.newBuilder().addPathSegment("controller").build(); 222 | final Request request = new Request.Builder().url(targetUrl).build(); 223 | return get(request, ZTController.class); 224 | } 225 | 226 | @Override 227 | public List getCNetworks() { 228 | final HttpUrl targetUrl = baseApiUrl.newBuilder() 229 | .addPathSegment("controller") 230 | .addPathSegment("network").build(); 231 | final Request request = new Request.Builder().url(targetUrl).build(); 232 | return Arrays.asList(get(request, String[].class)); 233 | } 234 | 235 | @Override 236 | public ZTCNetwork getCNetwork(@NotNull String networkId) { 237 | final HttpUrl targetUrl = baseApiUrl.newBuilder() 238 | .addPathSegment("controller") 239 | .addPathSegment("network") 240 | .addPathSegment(networkId) 241 | .build(); 242 | final Request request = new Request.Builder().url(targetUrl).build(); 243 | return get(request, ZTCNetwork.class); 244 | } 245 | 246 | @Override 247 | public ZTCNetwork updateCNetwork(@NotNull ZTCNetwork network) { 248 | if (network.getNwid() == null) 249 | throw new IllegalArgumentException("network ID must not be null"); 250 | 251 | final HttpUrl targetUrl = baseApiUrl.newBuilder() 252 | .addPathSegment("controller") 253 | .addPathSegment("network") 254 | .addPathSegment(network.getNwid()) 255 | .build(); 256 | 257 | final Request request = new Request.Builder() 258 | .url(targetUrl) 259 | .post(RequestBody.create(MEDIA_TYPE_JSON, gson.toJson(network))) 260 | .build(); 261 | return get(request, ZTCNetwork.class); 262 | } 263 | 264 | @Override 265 | public void deleteCNetwork(@NotNull String networkId) { 266 | final HttpUrl targetUrl = baseApiUrl.newBuilder() 267 | .addPathSegment("controller") 268 | .addPathSegment("network") 269 | .addPathSegment(networkId) 270 | .build(); 271 | 272 | final Request request = new Request.Builder() 273 | .url(targetUrl) 274 | .delete() 275 | .build(); 276 | try { 277 | execute(request); 278 | } catch (ZTServiceException ex) { 279 | // catch the 500 that's returned when deleting :/ 280 | if (!ex.getCause().getLocalizedMessage().contains("code=500")) { 281 | throw ex; 282 | } 283 | } 284 | } 285 | 286 | @Override 287 | public Map getCMembers(@NotNull String networkId) { 288 | final HttpUrl targetUrl = baseApiUrl.newBuilder() 289 | .addPathSegment("controller") 290 | .addPathSegment("network") 291 | .addPathSegment(networkId) 292 | .addPathSegment("member") 293 | .build(); 294 | final Type entityType = new TypeToken>(){}.getType(); 295 | final Request request = new Request.Builder().url(targetUrl).build(); 296 | final Map membersWithVersion = get(request, entityType); 297 | return Collections.unmodifiableMap(membersWithVersion); 298 | } 299 | 300 | @Override 301 | public ZTCMember getCMember(@NotNull String networkId, @NotNull String memberId) { 302 | final HttpUrl targetUrl = baseApiUrl.newBuilder() 303 | .addPathSegment("controller") 304 | .addPathSegment("network") 305 | .addPathSegment(networkId) 306 | .addPathSegment("member") 307 | .addPathSegment(memberId) 308 | .build(); 309 | final Request request = new Request.Builder().url(targetUrl).build(); 310 | return get(request, ZTCMember.class); 311 | } 312 | 313 | @Override 314 | public ZTCMember updateCMember(@NotNull ZTCMember member) { 315 | if (member.getNwid() == null) 316 | throw new IllegalArgumentException("network ID must not be null"); 317 | if (member.getAddress() == null) 318 | throw new IllegalArgumentException("address must not be null"); 319 | 320 | final HttpUrl targetUrl = baseApiUrl.newBuilder() 321 | .addPathSegment("controller") 322 | .addPathSegment("network") 323 | .addPathSegment(member.getNwid()) 324 | .addPathSegment("member") 325 | .addPathSegment(member.getAddress()) 326 | .build(); 327 | 328 | final Request request = new Request.Builder() 329 | .url(targetUrl) 330 | .post(RequestBody.create(MEDIA_TYPE_JSON, gson.toJson(member))) 331 | .build(); 332 | return get(request, ZTCMember.class); 333 | } 334 | 335 | @Override 336 | public void deleteCMember(@NotNull ZTCMember member) { 337 | if (member.getNwid() == null) 338 | throw new IllegalArgumentException("network ID must not be null"); 339 | if (member.getAddress() == null) 340 | throw new IllegalArgumentException("address must not be null"); 341 | deleteCMember(member.getNwid(), member.getAddress()); 342 | } 343 | @Override 344 | public void deleteCMember(@NotNull String networkId, @NotNull String memberId) { 345 | final HttpUrl targetUrl = baseApiUrl.newBuilder() 346 | .addPathSegment("controller") 347 | .addPathSegment("network") 348 | .addPathSegment(networkId) 349 | .addPathSegment("member") 350 | .addPathSegment(memberId) 351 | .build(); 352 | 353 | final Request request = new Request.Builder() 354 | .url(targetUrl) 355 | .delete() 356 | .build(); 357 | try { 358 | execute(request); 359 | } catch (ZTServiceException ex) { 360 | // catch the 500 that's returned when deleting :/ 361 | if (!ex.getCause().getLocalizedMessage().contains("code=500")) { 362 | throw ex; 363 | } 364 | } 365 | } 366 | 367 | 368 | //======================================= 369 | 370 | Response execute(Request request) { 371 | try { 372 | final Response response = client.newCall(request).execute(); 373 | if (!response.isSuccessful()) throw new IOException("Unexpected code " + response); 374 | return response; 375 | } catch(IOException e) { 376 | throw new ZTServiceException(e); 377 | } 378 | } 379 | 380 | T get(Request request, Class entityClass) { 381 | final Response response = execute(request); 382 | try { 383 | return gson.fromJson(response.body().charStream(), entityClass); 384 | } catch (IOException e) { 385 | throw new ZTClientException("cannot deserialize resource into its corresponding bean", e); 386 | } 387 | } 388 | 389 | T get(Request request, Type entityClass) { 390 | final Response response = execute(request); 391 | try { 392 | return gson.fromJson(response.body().charStream(), entityClass); 393 | } catch (IOException e) { 394 | throw new ZTClientException("cannot deserialize resource into its corresponding bean", e); 395 | } 396 | } 397 | 398 | } 399 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . --------------------------------------------------------------------------------