mirror of
https://github.com/google/nomulus.git
synced 2025-06-07 13:05:39 +02:00
Import code from internal repository to git
This commit is contained in:
Justine Tunney
commit
0ef0c933d2
2490 changed files with 281594 additions and 0 deletions
361
java/com/google/domain/registry/model/eppinput/EppInput.java
Normal file
361
java/com/google/domain/registry/model/eppinput/EppInput.java
Normal file
|
|
@ -0,0 +1,361 @@
|
|||
// Copyright 2016 Google Inc. All Rights Reserved.
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
package com.google.domain.registry.model.eppinput;
|
||||
|
||||
import static com.google.domain.registry.util.CollectionUtils.nullSafeImmutableCopy;
|
||||
import static com.google.domain.registry.util.CollectionUtils.nullToEmptyImmutableCopy;
|
||||
|
||||
import com.google.common.collect.FluentIterable;
|
||||
import com.google.common.collect.ImmutableList;
|
||||
import com.google.common.collect.ImmutableSet;
|
||||
import com.google.domain.registry.model.ImmutableObject;
|
||||
import com.google.domain.registry.model.contact.ContactCommand;
|
||||
import com.google.domain.registry.model.domain.DomainCommand;
|
||||
import com.google.domain.registry.model.domain.allocate.AllocateCreateExtension;
|
||||
import com.google.domain.registry.model.domain.fee.FeeCheckExtension;
|
||||
import com.google.domain.registry.model.domain.fee.FeeCreateExtension;
|
||||
import com.google.domain.registry.model.domain.fee.FeeInfoExtension;
|
||||
import com.google.domain.registry.model.domain.fee.FeeRenewExtension;
|
||||
import com.google.domain.registry.model.domain.fee.FeeTransferExtension;
|
||||
import com.google.domain.registry.model.domain.fee.FeeUpdateExtension;
|
||||
import com.google.domain.registry.model.domain.launch.LaunchCheckExtension;
|
||||
import com.google.domain.registry.model.domain.launch.LaunchCreateExtension;
|
||||
import com.google.domain.registry.model.domain.launch.LaunchDeleteExtension;
|
||||
import com.google.domain.registry.model.domain.launch.LaunchInfoExtension;
|
||||
import com.google.domain.registry.model.domain.launch.LaunchUpdateExtension;
|
||||
import com.google.domain.registry.model.domain.metadata.MetadataExtension;
|
||||
import com.google.domain.registry.model.domain.rgp.RgpUpdateExtension;
|
||||
import com.google.domain.registry.model.domain.secdns.SecDnsCreateExtension;
|
||||
import com.google.domain.registry.model.domain.secdns.SecDnsUpdateExtension;
|
||||
import com.google.domain.registry.model.eppinput.ResourceCommand.ResourceCheck;
|
||||
import com.google.domain.registry.model.eppinput.ResourceCommand.SingleResourceCommand;
|
||||
import com.google.domain.registry.model.host.HostCommand;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
|
||||
import javax.xml.bind.annotation.XmlAttribute;
|
||||
import javax.xml.bind.annotation.XmlElement;
|
||||
import javax.xml.bind.annotation.XmlElementRef;
|
||||
import javax.xml.bind.annotation.XmlElementRefs;
|
||||
import javax.xml.bind.annotation.XmlElementWrapper;
|
||||
import javax.xml.bind.annotation.XmlElements;
|
||||
import javax.xml.bind.annotation.XmlEnumValue;
|
||||
import javax.xml.bind.annotation.XmlRootElement;
|
||||
import javax.xml.bind.annotation.XmlType;
|
||||
import javax.xml.bind.annotation.adapters.XmlAdapter;
|
||||
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
|
||||
|
||||
/** This class represents the root EPP XML element for input. */
|
||||
@XmlRootElement(name = "epp")
|
||||
public class EppInput extends ImmutableObject {
|
||||
|
||||
@XmlElements({
|
||||
@XmlElement(name = "command", type = CommandWrapper.class),
|
||||
@XmlElement(name = "hello", type = Hello.class) })
|
||||
CommandWrapper commandWrapper;
|
||||
|
||||
public CommandWrapper getCommandWrapper() {
|
||||
return commandWrapper;
|
||||
}
|
||||
|
||||
public String getCommandName() {
|
||||
return (commandWrapper instanceof Hello)
|
||||
? Hello.class.getSimpleName()
|
||||
: commandWrapper.getCommand().getClass().getSimpleName();
|
||||
}
|
||||
|
||||
public ImmutableList<String> getTargetIds() {
|
||||
InnerCommand innerCommand = commandWrapper.getCommand();
|
||||
ResourceCommand resourceCommand = innerCommand instanceof ResourceCommandWrapper
|
||||
? ((ResourceCommandWrapper) innerCommand).getResourceCommand()
|
||||
: null;
|
||||
if (resourceCommand instanceof SingleResourceCommand) {
|
||||
return ImmutableList.of(((SingleResourceCommand) resourceCommand).getTargetId());
|
||||
} else if (resourceCommand instanceof ResourceCheck) {
|
||||
return ((ResourceCheck) resourceCommand).getTargetIds();
|
||||
} else {
|
||||
return ImmutableList.of();
|
||||
}
|
||||
}
|
||||
|
||||
/** Get the extension based on type, or null. If there are multiple, it chooses the first. */
|
||||
public <E extends CommandExtension> E getSingleExtension(Class<E> clazz) {
|
||||
return FluentIterable.from(getCommandWrapper().getExtensions()).filter(clazz).first().orNull();
|
||||
}
|
||||
|
||||
/** A tag that goes inside of an EPP {@literal <command>}. */
|
||||
public static class InnerCommand extends ImmutableObject {}
|
||||
|
||||
/** A command that has an extension inside of it. */
|
||||
public static class ResourceCommandWrapper extends InnerCommand {
|
||||
@XmlElementRefs({
|
||||
@XmlElementRef(type = ContactCommand.Check.class),
|
||||
@XmlElementRef(type = ContactCommand.Create.class),
|
||||
@XmlElementRef(type = ContactCommand.Delete.class),
|
||||
@XmlElementRef(type = ContactCommand.Info.class),
|
||||
@XmlElementRef(type = ContactCommand.Transfer.class),
|
||||
@XmlElementRef(type = ContactCommand.Update.class),
|
||||
@XmlElementRef(type = DomainCommand.Check.class),
|
||||
@XmlElementRef(type = DomainCommand.Create.class),
|
||||
@XmlElementRef(type = DomainCommand.Delete.class),
|
||||
@XmlElementRef(type = DomainCommand.Info.class),
|
||||
@XmlElementRef(type = DomainCommand.Renew.class),
|
||||
@XmlElementRef(type = DomainCommand.Transfer.class),
|
||||
@XmlElementRef(type = DomainCommand.Update.class),
|
||||
@XmlElementRef(type = HostCommand.Check.class),
|
||||
@XmlElementRef(type = HostCommand.Create.class),
|
||||
@XmlElementRef(type = HostCommand.Delete.class),
|
||||
@XmlElementRef(type = HostCommand.Info.class),
|
||||
@XmlElementRef(type = HostCommand.Update.class)})
|
||||
ResourceCommand resourceCommand;
|
||||
|
||||
public ResourceCommand getResourceCommand() {
|
||||
return resourceCommand;
|
||||
}
|
||||
}
|
||||
|
||||
/** Epp envelope wrapper for check on some objects. */
|
||||
public static class Check extends ResourceCommandWrapper {}
|
||||
|
||||
/** Epp envelope wrapper for create of some object. */
|
||||
public static class Create extends ResourceCommandWrapper {}
|
||||
|
||||
/** Epp envelope wrapper for delete of some object. */
|
||||
public static class Delete extends ResourceCommandWrapper {}
|
||||
|
||||
/** Epp envelope wrapper for info on some object. */
|
||||
public static class Info extends ResourceCommandWrapper {}
|
||||
|
||||
/** Epp envelope wrapper for renewing some object. */
|
||||
public static class Renew extends ResourceCommandWrapper {}
|
||||
|
||||
/** Epp envelope wrapper for transferring some object. */
|
||||
public static class Transfer extends ResourceCommandWrapper {
|
||||
|
||||
/** Enum of the possible values for the "op" attribute in transfer flows. */
|
||||
public enum TransferOp {
|
||||
@XmlEnumValue("approve")
|
||||
APPROVE,
|
||||
|
||||
@XmlEnumValue("cancel")
|
||||
CANCEL,
|
||||
|
||||
@XmlEnumValue("query")
|
||||
QUERY,
|
||||
|
||||
@XmlEnumValue("reject")
|
||||
REJECT,
|
||||
|
||||
@XmlEnumValue("request")
|
||||
REQUEST;
|
||||
}
|
||||
|
||||
@XmlAttribute(name = "op")
|
||||
TransferOp transferOp;
|
||||
|
||||
public TransferOp getTransferOp() {
|
||||
return transferOp;
|
||||
}
|
||||
}
|
||||
|
||||
/** Epp envelope wrapper for update of some object. */
|
||||
public static class Update extends ResourceCommandWrapper {}
|
||||
|
||||
/** Poll command. */
|
||||
public static class Poll extends InnerCommand {
|
||||
|
||||
/** Enum of the possible values for the "op" attribute in poll commands. */
|
||||
public enum PollOp {
|
||||
|
||||
/** Acknowledge a poll message was received. */
|
||||
@XmlEnumValue("ack")
|
||||
ACK,
|
||||
|
||||
/** Request the next poll message. */
|
||||
@XmlEnumValue("req")
|
||||
REQUEST;
|
||||
}
|
||||
|
||||
@XmlAttribute
|
||||
PollOp op;
|
||||
|
||||
@XmlAttribute
|
||||
String msgID;
|
||||
|
||||
public PollOp getPollOp() {
|
||||
return op;
|
||||
}
|
||||
|
||||
public String getMessageId() {
|
||||
return msgID;
|
||||
}
|
||||
}
|
||||
|
||||
/** Login command. */
|
||||
public static class Login extends InnerCommand {
|
||||
@XmlElement(name = "clID")
|
||||
String clientId;
|
||||
|
||||
@XmlElement(name = "pw")
|
||||
String password;
|
||||
|
||||
@XmlElement(name = "newPW")
|
||||
String newPassword;
|
||||
|
||||
Options options;
|
||||
|
||||
@XmlElement(name = "svcs")
|
||||
Services services;
|
||||
|
||||
public String getClientId() {
|
||||
return clientId;
|
||||
}
|
||||
|
||||
public String getPassword() {
|
||||
return password;
|
||||
}
|
||||
|
||||
public String getNewPassword() {
|
||||
return newPassword;
|
||||
}
|
||||
|
||||
public Options getOptions() {
|
||||
return options;
|
||||
}
|
||||
|
||||
public Services getServices() {
|
||||
return services;
|
||||
}
|
||||
}
|
||||
|
||||
/** Logout command. */
|
||||
public static class Logout extends InnerCommand {}
|
||||
|
||||
/** The "command" element that holds an actual command inside of it. */
|
||||
@XmlType(propOrder = {"command", "extension", "clTRID"})
|
||||
public static class CommandWrapper extends ImmutableObject {
|
||||
@XmlElements({
|
||||
@XmlElement(name = "check", type = Check.class),
|
||||
@XmlElement(name = "create", type = Create.class),
|
||||
@XmlElement(name = "delete", type = Delete.class),
|
||||
@XmlElement(name = "info", type = Info.class),
|
||||
@XmlElement(name = "login", type = Login.class),
|
||||
@XmlElement(name = "logout", type = Logout.class),
|
||||
@XmlElement(name = "poll", type = Poll.class),
|
||||
@XmlElement(name = "renew", type = Renew.class),
|
||||
@XmlElement(name = "transfer", type = Transfer.class),
|
||||
@XmlElement(name = "update", type = Update.class) })
|
||||
InnerCommand command;
|
||||
|
||||
/** Zero or more command extensions. */
|
||||
@XmlElementRefs({
|
||||
@XmlElementRef(type = AllocateCreateExtension.class),
|
||||
@XmlElementRef(type = FeeCheckExtension.class),
|
||||
@XmlElementRef(type = FeeCreateExtension.class),
|
||||
@XmlElementRef(type = FeeInfoExtension.class),
|
||||
@XmlElementRef(type = FeeRenewExtension.class),
|
||||
@XmlElementRef(type = FeeTransferExtension.class),
|
||||
@XmlElementRef(type = FeeUpdateExtension.class),
|
||||
@XmlElementRef(type = LaunchCheckExtension.class),
|
||||
@XmlElementRef(type = LaunchCreateExtension.class),
|
||||
@XmlElementRef(type = LaunchDeleteExtension.class),
|
||||
@XmlElementRef(type = LaunchInfoExtension.class),
|
||||
@XmlElementRef(type = LaunchUpdateExtension.class),
|
||||
@XmlElementRef(type = MetadataExtension.class),
|
||||
@XmlElementRef(type = RgpUpdateExtension.class),
|
||||
@XmlElementRef(type = SecDnsCreateExtension.class),
|
||||
@XmlElementRef(type = SecDnsUpdateExtension.class) })
|
||||
@XmlElementWrapper
|
||||
List<CommandExtension> extension;
|
||||
|
||||
String clTRID;
|
||||
|
||||
public String getClTrid() {
|
||||
return clTRID;
|
||||
}
|
||||
|
||||
public InnerCommand getCommand() {
|
||||
return command;
|
||||
}
|
||||
|
||||
public ImmutableList<CommandExtension> getExtensions() {
|
||||
return nullToEmptyImmutableCopy(extension);
|
||||
}
|
||||
}
|
||||
|
||||
/** Empty type to represent the empty "hello" command. */
|
||||
public static class Hello extends CommandWrapper {}
|
||||
|
||||
/** An options object inside of {@link Login}. */
|
||||
public static class Options extends ImmutableObject {
|
||||
@XmlJavaTypeAdapter(VersionAdapter.class)
|
||||
String version;
|
||||
|
||||
@XmlElement(name = "lang")
|
||||
String language;
|
||||
|
||||
public String getLanguage() {
|
||||
return language;
|
||||
}
|
||||
}
|
||||
|
||||
/** A services object inside of {@link Login}. */
|
||||
public static class Services extends ImmutableObject {
|
||||
@XmlElement(name = "objURI")
|
||||
Set<String> objectServices;
|
||||
|
||||
@XmlElementWrapper(name = "svcExtension")
|
||||
@XmlElement(name = "extURI")
|
||||
Set<String> serviceExtensions;
|
||||
|
||||
public ImmutableSet<String> getObjectServices() {
|
||||
return nullSafeImmutableCopy(objectServices);
|
||||
}
|
||||
|
||||
public ImmutableSet<String> getServiceExtensions() {
|
||||
return nullSafeImmutableCopy(serviceExtensions);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* RFC 5730 says we should check the version and return special error code 2100 if it isn't
|
||||
* what we support, but it also specifies a schema that only allows 1.0 in the version field, so
|
||||
* any other version doesn't validate. As a result, if we didn't do this here it would throw a
|
||||
* {@code SyntaxErrorException} when it failed to validate.
|
||||
*
|
||||
* @see "http://tools.ietf.org/html/rfc5730#page-41"
|
||||
*/
|
||||
public static class VersionAdapter extends XmlAdapter<String, String> {
|
||||
@Override
|
||||
public String unmarshal(String version) throws Exception {
|
||||
if (!"1.0".equals(version)) {
|
||||
throw new WrongProtocolVersionException();
|
||||
}
|
||||
return version;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String marshal(String ignored) throws Exception {
|
||||
throw new UnsupportedOperationException();
|
||||
}
|
||||
}
|
||||
|
||||
/** Marker interface for types that can go in the {@link CommandWrapper#extension} field. */
|
||||
public interface CommandExtension {}
|
||||
|
||||
/** Exception to throw if encountering a protocol version other than "1.0". */
|
||||
public static class WrongProtocolVersionException extends Exception {}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue