org.apache.commons.net.imap.IMAPReply Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-net Show documentation
Show all versions of commons-net Show documentation
Apache Commons Net library contains a collection of network utilities and protocol implementations.
Supported protocols include: Echo, Finger, FTP, NNTP, NTP, POP3(S), SMTP(S), Telnet, Whois
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.commons.net.imap;
import java.io.IOException;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.commons.net.MalformedServerReplyException;
/**
* IMAPReply stores IMAP reply code constants.
*/
public final class IMAPReply
{
/** The reply code indicating success of an operation. */
public static final int OK = 0;
/** The reply code indicating failure of an operation. */
public static final int NO = 1;
/** The reply code indicating command rejection. */
public static final int BAD = 2;
/** The reply code indicating command continuation. */
public static final int CONT = 3;
/**
* The reply code indicating a partial response.
* This is used when a chunk listener is registered and the listener
* requests that the reply lines are cleared on return.
* @since 3.4
*/
public static final int PARTIAL = 3;
/** The IMAP reply String indicating success of an operation. */
private static final String IMAP_OK = "OK";
/** The IMAP reply String indicating failure of an operation. */
private static final String IMAP_NO = "NO";
/** The IMAP reply String indicating command rejection. */
private static final String IMAP_BAD = "BAD";
// Start of line for untagged replies
private static final String IMAP_UNTAGGED_PREFIX = "* ";
// Start of line for continuation replies
private static final String IMAP_CONTINUATION_PREFIX = "+";
// Cannot be instantiated.
private IMAPReply()
{}
/**
* Checks if the reply line is untagged - e.g. "* OK ..."
* @param line to be checked
* @return {@code true} if the line is untagged
*/
public static boolean isUntagged(String line) {
return line.startsWith(IMAP_UNTAGGED_PREFIX);
}
/**
* Checks if the reply line is a continuation, i.e. starts with "+"
* @param line the line to be checked
* @return {@code true} if the line is untagged
*/
public static boolean isContinuation(String line) {
return line.startsWith(IMAP_CONTINUATION_PREFIX);
}
private static final String TAGGED_RESPONSE = "^\\w+ (\\S+).*"; // TODO perhaps be less strict on tag match?
// tag cannot contain: + ( ) { SP CTL % * " \ ]
private static final Pattern TAGGED_PATTERN = Pattern.compile(TAGGED_RESPONSE);
/**
* Intepret the String reply code - OK, NO, BAD - in a tagged response as a integer.
*
* @param line the tagged line to be checked
* @return {@link #OK} or {@link #NO} or {@link #BAD} or {@link #CONT}
* @throws IOException if the input has an unexpected format
*/
public static int getReplyCode(String line) throws IOException {
return getReplyCode(line, TAGGED_PATTERN);
}
private static final String UNTAGGED_RESPONSE = "^\\* (\\S+).*";
private static final Pattern UNTAGGED_PATTERN = Pattern.compile(UNTAGGED_RESPONSE);
private static final Pattern LITERAL_PATTERN = Pattern.compile("\\{(\\d+)\\}$"); // {dd}
/**
* Checks if the line introduces a literal, i.e. ends with {dd}
* @param line the line to check
*
* @return the literal count, or -1 if there was no literal.
*/
public static int literalCount(String line) {
Matcher m = LITERAL_PATTERN.matcher(line);
if (m.find()) {
return Integer.parseInt(m.group(1)); // Should always parse because we matched \d+
}
return -1;
}
/**
* Intepret the String reply code - OK, NO, BAD - in an untagged response as a integer.
*
* @param line the untagged line to be checked
* @return {@link #OK} or {@link #NO} or {@link #BAD} or {@link #CONT}
* @throws IOException if the input has an unexpected format
*/
public static int getUntaggedReplyCode(String line) throws IOException {
return getReplyCode(line, UNTAGGED_PATTERN);
}
// Helper method to process both tagged and untagged replies.
private static int getReplyCode(String line, Pattern pattern) throws IOException{
if (isContinuation(line)) {
return CONT;
}
Matcher m = pattern.matcher(line);
if (m.matches()) { // TODO would lookingAt() be more efficient? If so, then drop trailing .* from patterns
String code = m.group(1);
if (code.equals(IMAP_OK)) {
return OK;
}
if (code.equals(IMAP_BAD)) {
return BAD;
}
if (code.equals(IMAP_NO)) {
return NO;
}
}
throw new MalformedServerReplyException(
"Received unexpected IMAP protocol response from server: '" + line + "'.");
}
/**
* Checks whether the reply code indicates success or not
*
* @param replyCode the code to check
* @return {@code true} if the code equals {@link #OK}
*/
public static boolean isSuccess(int replyCode) {
return replyCode == OK;
}
/**
* Checks if the reply line is a continuation, i.e. starts with "+"
* @param replyCode the code to be checked
* @return {@code true} if the response was a continuation
*/
public static boolean isContinuation(int replyCode) {
return replyCode == CONT;
}
}
/* kate: indent-width 4; replace-tabs on; */